crysna 0.0.4

data/lib/crysna/optionmanager.rb

@@ -0,0 +1,177 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+require "optparse"
+
+#
+#
+#
+class Crysna::OptionManager
+
+  DEFAULT_CELLS_FILE              = 'cells.yaml'
+  DEFAULT_FITTED_STRUCTURE_FILE   = 'fittedstructure.yaml'
+  DEFAULT_OCCUPIED_SITES_FILE     = 'occupiedsite.yaml'
+  DEFAULT_MODEL_FILE              = 'model.yaml'
+  DEFAULT_SITE_CANDIDATE_FILE     = 'sitecandidate.yaml'
+  DEFAULT_SITE_COMBINATION_FILE   = 'sitecombination.yaml'
+  DEFAULT_SITE_MIGRATION_FILE     = 'sitemigration.yaml'
+  DEFAULT_SITE_OPERATION_FILE     = 'siteoperation.yaml'
+  DEFAULT_SITE_SINGLE_FILE        = 'sitesingle.yaml'
+  DEFAULT_SYM_OPERATION_FILE      = 'symoperation.yaml'
+  DEFAULT_SYM_ID_SITE_FILE        = 'symidsite.yaml'
+  DEFAULT_SITE_UNIQUE_FILE        = 'siteunique.yaml'
+
+  ALL_OPTIONS = [
+    :cells, :fitted, :occupied, :model, :symid,
+    :migration, :operation, :symmetry, :quiet,
+    :combination,
+    :candidate,
+    :single,
+    :unique,
+  ]
+
+
+  class INVARID_OPTION < Exception; end
+
+  attr_reader :options
+  attr_accessor :parser
+
+  # activates にセットしたものしか有効にしない。
+  def initialize(activates = ALL_OPTIONS)
+    @parser = OptionParser.new
+    @options = {}
+
+    activates.each do |option|
+      unless ALL_OPTIONS.include? option
+        raise INVARID_OPTION, option.to_s
+      end
+    end
+
+    activates.each do |opt|
+      case opt
+      when :cells      ; set_cells      
+      when :fitted     ; set_fitted     
+      when :occupied ; set_occupied 
+      when :model      ; set_model      
+      when :symid       ; set_symid       
+      when :migration  ; set_migration  
+      when :operation  ; set_operation  
+      when :symmetry   ; set_symmetry   
+      when :single     ; set_single     
+      when :unique     ; set_unique     
+      when :quiet      ; set_quiet   
+      when :combination   ; set_combination  
+      when :candidate     ; set_candidate    
+      else
+      end
+
+    end
+  end
+
+  def set_cells       
+    @options[:cells]        = DEFAULT_CELLS_FILE
+    @parser.on("-c file",
+         "--cells=file",
+         "Indicate cells file. #{DEFAULT_CELLS_FILE} as default"
+         ){|str| @options[:cells] = str}
+  end
+
+  def set_fitted      
+    @options[:fitted]       = DEFAULT_FITTED_STRUCTURE_FILE
+    @parser.on("-f file",
+         "--fitted=file",
+         "Indicate fitted_structure file. #{DEFAULT_FITTED_STRUCTURE_FILE} as default"
+         ){|str| @options[:fitted] = str}
+  end
+
+  def set_occupied  
+    @options[:occupied]   = DEFAULT_OCCUPIED_SITES_FILE
+    @parser.on("-p file",
+         "--occupied=file",
+         "Indicate occupied_site file. Default: #{DEFAULT_OCCUPIED_SITES_FILE}"
+         ){|str| @options[:occupied] = str}
+  end
+
+  def set_model       
+    @options[:model]        = DEFAULT_MODEL_FILE
+    @parser.on("-m file",
+         "--model=file",
+         "Indicate model_structure file. Default: #{DEFAULT_MODEL_FILE}"
+         ){|str| @options[:model] = str}
+  end
+
+  def set_symid        
+    @options[:symid]        = DEFAULT_SYM_ID_SITE_FILE
+    @parser.on("-i file",
+         "--symmetric-id=file",
+         "Indicate symmetric_identification file. Default: #{DEFAULT_SYM_ID_SITE_FILE}"
+         ){|str| @options[:symid] = str}
+  end
+
+  def set_migration   
+    @options[:migration]    = DEFAULT_SITE_MIGRATION_FILE
+    @parser.on("-M file",
+         "--sitemigration=file",
+         "Indicate site_migration file. #{DEFAULT_SITE_MIGRATION_FILE} as default"
+         ){|str| @options[:migration] = str}
+  end
+
+  def set_operation   
+    @options[:operation]    = DEFAULT_SITE_OPERATION_FILE
+    @parser.on("-o file",
+         "--siteoperation=file",
+         "Indicate site_operation file. #{DEFAULT_SITE_OPERATION_FILE} as default"
+         ){|str| @options[:operation] = str}
+  end
+
+  def set_symmetry    
+    @options[:symmetry]     = DEFAULT_SYM_OPERATION_FILE
+    @parser.on("-y file",
+         "--symmetry=file",
+         "Indicate symmetry_operation file. #{DEFAULT_SYM_OPERATION_FILE} as default"
+         ){|str| @options[:symmetry] = str}
+  end
+
+  def set_single    
+    @options[:single]     = DEFAULT_SITE_SINGLE_FILE
+    @parser.on("-s file",
+         "--single=file",
+         "Indicate site_single file. #{DEFAULT_SITE_SINGLE_FILE} as default"
+         ){|str| @options[:single] = str}
+  end
+
+  def set_unique    
+    @options[:unique]     = DEFAULT_SITE_UNIQUE_FILE
+    @parser.on("-u file",
+         "--unique=file",
+         "Indicate site_unique file. #{DEFAULT_SITE_UNIQUE_FILE} as default"
+         ){|str| @options[:unique] = str}
+  end
+
+  def set_combination
+    @options[:combination]     = DEFAULT_SITE_COMBINATION_FILE
+    @parser.on("-b file",
+         "--combination=file",
+         "Indicate site_combination file. #{DEFAULT_SITE_COMBINATION_FILE} as default"
+         ){|str| @options[:combination] = str}
+  end
+
+  def set_candidate
+    @options[:candidate]     = DEFAULT_SITE_CANDIDATE_FILE
+    @parser.on("-d file",
+         "--candidate=file",
+         "Indicate site_candidate file. #{DEFAULT_SITE_CANDIDATE_FILE} as default"
+         ){|str| @options[:candidate] = str}
+  end
+
+  def set_quiet
+    @options[:quiet]     = false
+    @parser.on("-q"    , "--quite"    , "Supress standard output."){   
+      @options[:quiet] = true}
+  end
+
+  def parse!(ary)
+    @parser.parse!(ary)
+  end
+
+end

data/lib/crysna/site.rb

@@ -0,0 +1,35 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+#require "rubygems"
+#require "mageo"
+
+#
+#
+#
+class Crysna::Site
+  attr_reader :name, :global_vector #, :polyhedron
+  attr_accessor :internal_vector
+
+  class NotSetInternalVectorError < Exception; end
+
+  #
+  def initialize(name, global_vector)
+    @name = name
+    @global_vector = global_vector.to_v3di
+  end
+
+  def equal?(other)
+    return false unless self.name == other.name
+    return false unless same_globla_vector?(other)
+    return true
+  end
+  alias :== :equal?
+
+  def same_globla_vector?(other)
+    return false unless self.global_vector == other.global_vector
+    return true
+  end
+
+end
+

data/lib/crysna/siteconfiguration.rb

@@ -0,0 +1,26 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+#
+# 座標情報を持たず、ラベル名でのみセルを表現するクラス
+#
+class Crysna::SiteConfiguration
+  attr_reader :elem_sites
+  #
+  def initialize(hash)
+    @elem_sites = hash
+  end
+
+  def self.generate_cell(elems, sites)
+    ##pp elems, sites
+    #cell = {}
+    #elems.each do |elem, num|
+    #    site_elem = []
+    #    num.times { site_elem << sites.shift}
+    #    cell[elem] = site_elem
+    #end
+    #return cell
+  end
+
+end
+

data/lib/crysna/sitenamelabeledcell.rb

@@ -0,0 +1,220 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+#require "crystal/cell2.rb"
+#require "crystal/periodiccell.rb"
+
+# 原子に一意のサイト名がついていることを前提とする幾つかのメソッドのためのクラス。
+# このクラスになってさえいれば、この前提はクリアしたものとして扱える。
+# また、サイト名が unique に原子につけられることを new するときにチェックする。
+#
+# このクラスがなかったら、このプログラム用の雑多なメソッドを CrystalCell::PeriodicCell に
+# 入れなければならなくなるので、名前空間の切り分け的な機能も期待。
+#
+# 通常の CrystalCell::Cell 系クラスとの大きな違いとして、
+# モデル構造のサイト名と座標をハッシュとしてインスタンス変数に持つ。
+#
+# new されたときに最近接のサイトでサイト名を原子につけるが、
+# その後操作を加えたら、
+# つけられたサイト名がその時点で最近接であることは保証されない。
+# このクラスはあまり汎用性を考えない。
+# 厳密な定義とか、他の CrystalCell::Cell系クラスとの整合性よりも
+# 早いプログラミングを目的とする。
+class SiteNameLabeledCell < CrystalCell::Cell
+  TOLERANCE = 1.0E-5
+
+  class InitializeError < Exception; end
+  class TypeError < Exception; end
+  class RangeError < Exception; end
+  class OutOfCellError < Exception; end
+
+  undef add_atom
+
+  # sites はサイト名を鍵、内部座標を値とするハッシュ。
+  # 内部座標は Mageo::Vector3DInternal クラスインスタンスであることを前提とする。
+  #
+  # サイト名の数(sites.size)と保持している原子の数が違えば例外。
+  # 
+  # 一対一対応しなければ例外。
+  # 例外は比較的頻繁に生じるだろうから、
+  # 外部で例外をキャッチする必要があることに注意。
+  def initialize(axes, atoms, sites)
+
+    unless atoms.size == sites.size
+      raise InitializeError,
+      "atoms.size is #{atoms.size}, while sites.size is #{sites.size}"
+    end
+    #super(axes)
+    @axes    = axes
+    @sites = sites
+
+    self.class.check_inside_all_sites(@sites)
+
+    atoms = self.class.label_sitenames(axes, atoms, sites)
+    unless self.class.labeled_all_atoms?(atoms, sites)
+      raise InitializeError,
+        "Not labeled site names for every atom."
+    end
+
+    @atoms = self.class.periodically_translate_atoms_to_nearest_site(axes, atoms, sites)
+    unless self.class.unique_sitenames?(@atoms)
+      raise InitializeError,
+        "Not unique site names for atoms."
+    end
+  end
+
+  # 各原子に付いているサイト名を見て、
+  # そのサイト座標と原子座標の空間的な距離の二乗を全ての原子について和を取り、
+  # その値を返す。
+  def sum_square_distances
+    @atoms.inject(0.0) do |result, atom|
+      result += (self.to_pcell.nearest_distance(@sites[atom.name] , atom.position))**2
+    end
+  end
+
+  # CrystalCell::Cell クラスインスタンスに変換したものを返す。
+  # 原子の座標はそのまま変換しない。
+  def to_cell
+    result = CrystalCell::Cell.new(@axes)
+    result.comment = self.comment
+    @atoms.each do |atom|
+      result.add_atom(atom)
+    end
+    return result
+  end
+
+  # 原子座標の相加平均を内部座標で返す。
+  def center_of_atoms
+    sum = Mageo::Vector3DInternal[0.0, 0.0, 0.0]
+    @atoms.each do |atom|
+      sum += atom.position
+    end
+    sum = sum * (1.0/(@sites.size.to_f))
+  end
+
+  # モデルサイト座標の相加平均を内部座標で返す。
+  def center_of_sites
+    sum = Mageo::Vector3DInternal[0.0, 0.0, 0.0]
+    @sites.each do |sitename, vec|
+      sum += vec
+    end
+    sum = sum * (1.0/(@sites.size.to_f))
+  end
+
+  # サイト名を鍵、その原子の内部座標を値とするハッシュ を返す。
+  def sitenames_positions
+    results = {}
+    @atoms.each do |i|
+      results[i.name] = i.position
+    end
+    return results
+  end
+
+  # サイト名を鍵、その原子の元素を値とするハッシュ を返す。
+  def sitenames_elements
+    results = {}
+    @atoms.each do |i|
+      results[i.name] = i.element
+    end
+    return results
+  end
+
+  private
+
+  # 与えられた原子のリストのそれぞれの原子について、
+  # 周期境界条件的に最も近いサイトを判定し
+  # 原子にサイト名をつけるた原子に map した配列を返す。
+  def self.label_sitenames(axes, atoms, sites)
+    atoms.each do |atom|
+      name = SiteNameLabeledCell.nearest_site(axes, atom.position, sites)
+      atom.name = name
+    end
+    return atoms
+  end
+
+  # 与えられた原子のリストのそれぞれの原子につけられたサイト名から、
+  # サイトの座標に最も近くなるように周期的並進移動した原子に map した配列を返す。
+  # 原子の内部座標は 0〜1 の間になるとは限らない。
+  def self.periodically_translate_atoms_to_nearest_site(axes, atoms, sites)
+    cell = CrystalCell::PeriodicCell.new(axes, atoms)
+    atoms = cell.atoms
+    atoms.map! do |atom|
+      translation = cell.nearest_direction(atom.position, sites[atom.name])
+      atom.translate(translation * (-1.0))
+    end
+    return atoms
+  end
+
+  # 引数で与えられた 格子の軸、サイト名ハッシュに対して、
+  # 与えられた内部座標 に最も近いサイト名の文字列を返す。
+  def self.nearest_site(axes, internal_coord, sites)
+    pc = CrystalCell::PeriodicCell.new(axes)
+    results = sites.min_by do |key, val|
+      pc.nearest_distance(val, internal_coord)
+    end
+    return results[0]
+  end
+  #private_class_method :nearest_site
+
+  # 原子についているサイト名が uniq なら true
+  def self.unique_sitenames?(atoms)
+    sitenames = atoms.map{|atom| atom.name}
+    return false if sitenames.include?(nil)
+    return sitenames.uniq.size == atoms.size
+  end
+  #private_class_method :unique_sitenames?
+
+  # 各サイトについて内部座標が 0以上1未満でなければ
+  # 例外 SiteNameLabeledCell::OutOfCellError を生じる。
+  def self.check_inside_all_sites(sites)
+    sites.each do |name, vec|
+      vec.to_a.each do |val|
+        if (val < 0.0-TOLERANCE) || (1.0+TOLERANCE <= val)
+          raise OutOfCellError, "#{name}, #{vec.inspect}"
+        end
+      end
+    end
+  end
+
+  def self.labeled_all_atoms?(atoms, sites)
+    atoms.each do |atom|
+      return false unless sites.keys.include?(atom.name)
+    end
+    return true
+  end
+
+  # 引数で与えられたサイト名に対して最も近い原子の @atoms 内の index を返す。
+  # サイト名 site_name は文字列であることを前提とする。
+  def nearest_atom_index(site_name)
+    raise SiteNameLabeledCell::TypeError if site_name.class != String
+    min_d = self.to_pcell.nearest_distance(@sites[site_name], @atoms[0].position)
+    min_id = 0
+    @atoms.size.times do |i|
+      tmp = self.to_pcell.nearest_distance(@sites[site_name], @atoms[i].position)
+      if tmp < min_d
+        min_d = tmp
+        min_id = i
+      end
+    end
+    return min_id
+  end
+
+  #def site_name(pos)
+  # raise SiteNameLabeledCellTypeError if pos.class == Mageo::Vector3D
+  # k
+  #end
+
+end
+
+class CrystalCell::Cell
+  # CrystalCell::Cell クラスインスタンスを SiteNameLabeledCell クラスインスタンスに
+  # 変換したものを返す。
+  # 細かい挙動は SiteNameLabeledCell.initialize を参照のこと。
+  # sites には サイト名を鍵、内部座標を値としたハッシュを渡す。
+  def to_snlcell(sites)
+    result = SiteNameLabeledCell.new(@axes, @atoms, sites)
+    result.comment = self.comment
+    return result
+  end
+end
+