crysna 0.0.4

data/lib/crysna/frameinterstitialcell.rb

@@ -0,0 +1,309 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+#require "crystal/cell2.rb"
+#require "mathextension/octahedron.rb"
+#require "mathextension/tetrahedron.rb"
+#require "mathextension/vector3d.rb"
+#require "mathextension/vector3dinternal.rb"
+#require "crysna/frameatom.rb"
+#require "crysna/interstitialatom.rb"
+#require "crysna/sitenamelabeledcell.rb"
+#require "progressbar"
+
+#
+# Cell modeled by frame atoms and interstitial atoms.
+# All atoms must be FrameAtom or InterstitialAtom class instance,
+# not CrystalCell::Atom class instance.
+#
+#class FrameInterstitialCell < CrystalCell::PeriodicCell
+class FrameInterstitialCell < CrystalCell::Cell
+
+  class TypeError < Exception; end
+  class NoMatchError < Exception; end
+
+  # Argument 'atoms' must be Array of atoms
+  # whose class is FrameAtom or InterstitialAtom.
+  # If 'atoms' includes CrystalCell::Atom class instance,
+  # raise exception 'FrameInterstitialCell::TypeError'
+  def initialize(axes, atoms = [])
+    atoms.each_with_index do |atom, i|
+      unless (atom.is_a?(FrameAtom) || (atom.is_a?(InterstitialAtom)))
+        raise TypeError,
+        "'atoms' includes #{atom.class} at #{i}."
+      end
+    end
+    super(axes, atoms)
+  end
+
+  # サイト情報を参照して、骨格原子が最適になるように
+  # 48個の変換操作・並進移動を然るべく施したセル( self.class のインスタンス )を返す。
+  # 非破壊的
+  # 引数 sites はサイト情報を入れたハッシュ。キーがサイト名、値がサイトの内部座標。
+  # サイトと原子が一対一対応する候補が見つからない場合は
+  # 例外 FrameInterstitialCell::NoMatchError を返す。
+  # 原子の順番は非保存。
+  #def most_matching_cell_pair(sites, log_io )
+  def optimized_cell( sites, log_io )
+    # 48個のセルに対し、サイト数ごとに roughly translate したセルを作る。
+    # サイト数が 8 ならば 48*8 個の Array になる。
+    cells = equivalent_cells.map{ |cell|
+      tmp = []
+      sites.each do |name, vec|
+        translation_rough = vec - cell.frame_atoms[0].position
+        t_cell = cell.translate(translation_rough)
+        t_cell.comment += sprintf(
+          "; Rough translation: (% 7.5f, % 7.5f, % 7.5f), 0th atom of frame to #{name}",
+          * (translation_rough)
+        )
+        tmp << t_cell
+      end
+      tmp
+    }.flatten
+
+    p_io = $stderr
+    p_io = File.open(File::NULL, "w") if $test == true
+    pbar = ProgressBar.new("FrameInterstitialCell::optimized_cell", cells.size, p_io)
+
+    # 操作と評価を全てに対して行う。
+    min_cell = nil
+    min_sum  = nil
+    cells.each do |cell|
+      pbar.inc
+      # SiteNameLabeledCell に変換できない cell が含まれるため、
+      # min_by メソッドは使えない。
+
+      log_io.puts("    #{cell.comment.sub("; ", " \\\n    ")}")
+      log_io.puts("        atom coordinates:")
+      cell.atoms.each_with_index do |atom, index|
+        log_io.printf("          (% 7.5f, % 7.5f, % 7.5f), Element:%s, %02i-th atom.\n",
+          * (atom.position), atom.element, index )
+      end
+
+      f_cell = cell.frame_cell
+      i_cell = cell.interstitial_cell.to_pcell.to_cell.to_ficell([])
+
+      # SiteNameLabeledCell に変換
+      begin
+        snlcell = f_cell.to_snlcell(sites)
+      rescue SiteNameLabeledCell::InitializeError
+        log_io.puts "            Not correspond atoms for sitenames."
+        log_io.puts
+        next # 一対一対応しない場合、無視する。
+      end
+
+      # 原子の重心とサイトの重心が一致するように
+      # 精密化した translation を行う。
+      translation_prec =
+        snlcell.center_of_sites - snlcell.center_of_atoms
+      snlcell.translate!(translation_prec)
+      i_cell.translate!(translation_prec)
+      [snlcell, i_cell].each do |cell|
+        cell.comment += sprintf(
+          "; Precise translation: (% 7.5f, % 7.5f, % 7.5f)\n",
+          * (translation_prec)
+        )
+      end
+
+      # log 出力
+      log_io.puts("            Found frame atoms:")
+      frame_atoms.each do |atom|
+        log_io.printf("          (% 7.5f, % 7.5f % 7.5f), #{atom.name}\n",
+          * atom.position
+        )
+      end
+
+      # 二乗和で評価
+      sum = snlcell.sum_square_distances
+      log_io.printf( "            Sum of square distances: %8.4f.\n\n", sum )
+      if (min_sum == nil) || (sum < min_sum)
+        min_sum = sum
+        min_cell = snlcell.to_cell.to_ficell.unite(i_cell)
+      end
+    end
+    pbar.finish
+
+    unless min_cell.class == FrameInterstitialCell
+      raise NoMatchError,
+      "Class of min_cell is #{min_cell.class}"
+    end
+
+    log_io.puts(    "    Chosen cell: #{min_cell.comment}")
+    log_io.puts(    "                    sum of square distances: #{min_sum}")
+
+    # サイト情報をここで全部書き出しておく。
+    log_io.puts("        Atoms:")
+    min_cell.atoms.each do |atom|
+      log_io.printf(
+        "            (% 7.5f, % 7.5f, % 7.5f), element %s, %s.\n",
+        * atom.position,
+        atom.element, 
+        atom.name,
+      )
+    end
+    #logs.each do |line|
+    # log_io.puts line
+    #end
+    log_io.puts
+
+    return min_cell
+  end
+
+  # @atoms のうち、 FrameAtom のものだけをまとめて Array にして返す。
+  def frame_atoms
+    @atoms.select{|atom| atom.class == FrameAtom}
+  end
+
+  # @atoms のうち、 InterstitialAtom のものだけをまとめて Array にして返す。
+  def interstitial_atoms
+    @atoms.select{|atom| atom.class == InterstitialAtom}
+  end
+
+  # @atoms のうち、 FrameAtom のものだけを含んだ
+  # FrameInterstitialCell を返す。
+  def frame_cell
+    result = FrameInterstitialCell.new(@axes, frame_atoms)
+    result.comment = self.comment
+    return result
+  end
+
+  # @atoms のうち、 InterstitialAtom のものだけを含んだ
+  # FrameInterstitialCell を返す。
+  def interstitial_cell
+    result = FrameInterstitialCell.new(@axes, interstitial_atoms)
+    result.comment = self.comment
+    return result
+  end
+
+  # 保持する原子群について、
+  # 元素ごとに分類し、元素を鍵とするハッシュとする。
+  # ハッシュの値はその元素の原子それぞれに付けられた名前で、ソート済の配列。
+  def elements_names
+    results = {}
+    @atoms.each do |atom|
+      elem = atom.element
+      if results[elem]
+        results[elem] << atom.name
+      else
+        results[elem] = [atom.name]
+      end
+    end
+    results.each_value do |val|
+      val.sort!
+    end
+    return results
+  end
+
+  private
+
+  # セルに対して格子ベクトルの反転・交換操作を組み合わせた結果生じる
+  # 全 48 個のセルを配列にして返す。
+  # 鏡像操作は含まれない。
+  # 交換 → 反転 の順で操作を施す。
+  # 返される配列内部の順序は、以下の組み合わせ。
+  #
+  #       範囲  a反転 b反転 c反転
+  #       00-05       x           x           x
+  #       06-11       o           x           x
+  #       12-17       x           o           x
+  #       18-23       o           o           x
+  #       24-29       x           x           o
+  #       30-35       o           x           o
+  #       36-41       x           o           o
+  #       42-47       o           o           o
+  #
+  #       各々の範囲中では、6要素が以下の順序。
+  #           00: a,b,c(a,b 交換→ a,b交換)(交換なし)
+  #           01: b,c,a(a,b 交換→ b,c交換)
+  #           02: c,a,b(a,b 交換→ c,a交換)
+  #           03: b,a,c(a,b 交換)
+  #           04: a,c,b(b,c 交換)
+  #           05: c,b,a(c,a 交換)
+  def equivalent_cells
+    results = []
+    gen_size = 48
+
+    gen_size.times do |i|
+      cell = Marshal.load(Marshal.dump(self))
+      comments = [
+        sprintf("Equivalent cell No.%02d: Original", i)
+      ]
+      case i % 6
+      when 0
+        #"do nothing"
+      when 1
+        cell.exchange_axes!([0,1])
+        cell.exchange_axes!([1,2])
+        comments << "Axes exchanged(a,b,c -> b,c,a)"
+      when 2
+        cell.exchange_axes!([0,1])
+        cell.exchange_axes!([2,0]) 
+        comments << "Axes exchanged(a,b,c -> c,a,b)"
+      when 3
+        cell.exchange_axes!([0,1]) 
+        comments << "Axes exchanged(a,b,c -> b,a,c)"
+      when 4
+        cell.exchange_axes!([1,2]) 
+        comments << "Axes exchanged(a,b,c -> a,c,b)"
+      when 5
+        cell.exchange_axes!([2,0]) 
+        comments << "Axes exchanged(a,b,c -> c,b,a)"
+      end
+
+      if ((i / 6) % 2 == 1)
+        cell.inverse_axis!(0)
+        comments << "Axis 'a' inversed"
+      end
+      if ((i / 12) % 2 == 1)
+        cell.inverse_axis!(1)
+        comments << "Axis 'b' inversed"
+      end
+      if ((i / 24) % 2 == 1)
+        cell.inverse_axis!(2)
+        comments << "Axis 'c' inversed"
+      end
+
+      #if ((i / 48) % 2 == 1)
+      # cell.reflect!
+      # comments << "Reflected"
+      #end
+
+      cell.comment = comments.join(" -> ") + "."
+      results << cell
+    end
+    return results
+  end
+
+end
+
+class CrystalCell::Cell
+  # frame_atom_ids で 骨格原子になるべき原子の indices を与える。
+  # frame_atom_ids が与えなければ、全ての原子が FrameAtom になる。
+  # 全ての原子を InterstitialAtom にするには、空配列を与えれば良い。
+  def to_ficell(frame_atom_ids = nil)
+    result = FrameInterstitialCell.new(@axes)
+    result.comment = self.comment
+    if frame_atom_ids
+      @atoms.each_with_index do |atom, i|
+        if frame_atom_ids.include?(i)
+          added_atom = FrameAtom.new(
+            atom.element, atom.position, atom.name, atom.movable_flags
+          )
+        else
+          added_atom = InterstitialAtom.new(
+            atom.element, atom.position, atom.name, atom.movable_flags
+          )
+        end
+        result.add_atom(added_atom)
+      end
+    else
+      @atoms.each_with_index do |atom, i|
+        added_atom = FrameAtom.new(
+          atom.element, atom.position, atom.name, atom.movable_flags
+        )
+        result.add_atom(added_atom)
+      end
+    end
+    return result
+  end
+end

data/lib/crysna/interstitialatom.rb

@@ -0,0 +1,13 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+#require "crystal/atom2.rb"
+
+#
+# Class for frame atom.
+# This class is the same as CrystalCell::Atom, except for the class name.
+# This class is assumed to be used in FrameInterstitialCell.
+#
+class InterstitialAtom < CrystalCell::Atom
+end
+

data/lib/crysna/modelstructure.rb

@@ -0,0 +1,333 @@
+#! /usr/bin/env ruby
+#coding: utf-8
+
+require "yaml"
+
+#サイト情報などを抽象化したモデル構造を扱うクラス。
+#内部的に、格子定数 1.0 の cubic なセルと見做して処理している。
+#initialize 時点で作った以降は内部データが変更されないことを前提としている。
+#(@polyhedra を作っておいた方が速そうとか思ったが、テストしてみたら変わらんかった。)
+#
+#体積関係のエラーチェックは、ininialize 時には行わない。
+class Crysna::ModelStructure #< CrystalCell::Cell
+  ELEMENT = 0
+  TOLERANCE = 1.0E-10
+
+  class InitializeError < Exception; end
+  class SiteVolumeError < Exception; end
+  class NoEntrySiteError < Exception; end
+  class SiteRangeError < Exception; end
+  class SiteDetectionError < Exception; end
+
+  attr_reader :symmetry_operations,
+    :frame_elements,
+    :frame_sites,
+    :axes,
+    :octahedral_sites,
+    :tetrahedral_sites,
+    :scatter_sites
+
+  def initialize(hash)
+    ##不可欠な要素がなければ例外、というのはやめる[2014-12-09]
+    #raise InitializeError if hash["frame_elements"] == nil
+    #raise InitializeError if hash["frame_sites"] == nil
+    #raise InitializeError if hash["symmetry_operations"] == nil
+
+    items = [
+      "frame_elements",
+      "frame_sites",
+      "symmetry_operations",
+      "tetrahedral_sites",
+      "octahedral_sites",
+      "scatter_sites",
+    ]
+    hash.keys.each do |key|
+      #未知の項目があれば例外。
+      raise InitializeError, "#{key} is not found" unless items.include?(key)
+    end
+
+    @axes = CrystalCell::LatticeAxes.new([
+        [1.0, 0.0, 0.0],
+        [0.0, 1.0, 0.0],
+        [0.0, 0.0, 1.0],
+    ])
+
+    @frame_elements = hash["frame_elements"]
+
+    @frame_sites    = {}
+    hash["frame_sites"].each do |name, pos|
+      @frame_sites[name] = pos.to_v3di
+    end
+
+    @symmetry_operations = hash["symmetry_operations"] || []
+    @tetrahedral_sites = hash["tetrahedral_sites"] || []
+    @octahedral_sites    = hash["octahedral_sites" ] || []
+
+    @scatter_sites                 = {}
+    if hash["scatter_sites"]
+      hash["scatter_sites"].each do |name, pos|
+        @scatter_sites[name] = pos.to_v3di
+      end
+    end
+
+    ##Check coodinates are 0 <= x,y,z < 1
+    ## This check is not needed. [2013-07-30]
+    #frame_sites.each do |name, vec|
+    #    vec.each do |x|
+    #        raise SiteRangeError, "#{name}, #{vec.to_s}" if (x < 0.0 || 1.0 <= x)
+    #    end
+    #end
+
+    ## This check is not needed. [2013-07-30]
+    #polyhedra.each do |name, polyhedron |
+    #    vec = polyhedron.center
+    #    vec.each do |x|
+    #        raise SiteRangeError, "#{name}, #{vec.to_s}" if (x < 0.0 || 1.0 <= x)
+    #    end
+    #end
+
+  end
+
+  #yaml から生成
+  def self.load_file(yaml)
+    hash = YAML.load_file(yaml)
+    self.new(hash)
+  end
+
+  def check_volume
+  #def check_sanity
+    #### check invalid symmetry operation
+    @symmetry_operations.each do |ope|
+      #pp ope
+      unless ope.has_key?("rotation") && ope.has_key?("translation")
+        message = "invalid symmetry_operation, #{@symmetry_operations}"
+        raise InitializeError, message
+      end
+    end
+
+
+    #体積の総和が 1.0 に近いか。
+    sum_volumes = polyhedra.values.inject(0.0) do |sum, polyhedron|
+      sum += polyhedron.volume
+    end
+    unless (sum_volumes - 1.0).abs < TOLERANCE
+      message = "Sum of volumes(#{sum_volumes}) not 1.0: \n"
+      polyhedra.each do |key, polyhedron|
+        message += sprintf("%10s: %10.5f\n", key, polyhedron.volume)
+      end
+      raise SiteVolumeError, message
+    end
+  end
+
+  #Return all site names.
+  def site_names
+    polyhedra.keys
+  end
+
+
+  #与えられた座標が、どの格子間サイトを占有するか、そのサイト名の文字列を返す。
+  #第1引数は対象の内部座標
+  #    内部座標 positions が 0-1 の範囲になければ、
+  #    自動的にセル内部に周期的並進移動させる。
+  #
+  #前提として全てのサイトが完全直交のような形になっていなければならないが、
+  #このチェックはこのメソッドに食わせる以前にチェックされているものとする。
+  #どのサイトにも該当しない場合についても、
+  #このメソッドに食わせる以前にチェックされているものとする。
+  #
+  #リストのどの格子間サイトにも含まれていないと判定されれば RuntimeError を投げる。
+  #しかしこれは正しくサイト設定されていれば起こらない筈。TODO そうでもなさそう。[2013-08-03]見つからなければ SiteDetectionError を投げる。
+  #が、演算誤差はやっぱり怖いので tolerance を設定する。
+  #periodic cell でtranslate したセルの座標は隙間ができそう。
+  def find_interstitial_site(position, tolerance, log_io)
+    candidates = select_interstitial_sites27(position, tolerance, log_io)
+    raise SiteDetectionError if candidates.empty?
+    choose_zyx(candidates).name
+  end
+
+  #Return Array of all sites which include the position
+  #among surrounding 3x3x3 cells.
+  #If the position is on the border, the results should be plural.
+  def select_interstitial_sites27(position, tolerance, log_io)
+    #MEMO:
+    #概念的には position に対して 多面体を 3x3x3 = 27個用意してどれかに入るか、
+    #というチェックを行うのだが、
+    #実装としては多面体は1つ固定して、 position を 27 個移動させてどれかが入るか、
+    #というチェックを行う。
+    #数学的に等価な判定になるし、後者の方が速度的に有利。
+
+    #セルの内側であることを保証する。
+    position = Mageo::Vector3D[*position]
+    position -= position.floor
+
+    results = []
+    polyhedra.each do |name, polyhedron|
+      log_io.puts("        Checking #{name}:")
+
+      log_io.puts("            Vertices:")
+      polyhedron.vertices.each do |vertex|
+        log_io.printf(
+          "                (% 7.5f, % 7.5f, % 7.5f)inter.\n", * vertex
+        )
+      end
+
+      log_io.puts(    "            Generating 3x3x3 periodic coordinates of atom:")
+      log_io.printf("              orig = (% 5.3f, % 5.3f, % 5.3f)\n",
+              * position)
+      (-1).upto(1).each do |c|
+        (-1).upto(1).each do |b|
+          (-1).upto(1).each do |a|
+            log_io.printf("              orig+(% 1d, % 1d, % 1d)inter.", a, b, c)
+            pos = position.to_v3d +
+              Mageo::Vector3D[-1.0,    0.0,    0.0] * a +
+              Mageo::Vector3D[ 0.0, -1.0,  0.0] * b +
+              Mageo::Vector3D[ 0.0,    0.0, -1.0] * c
+              #-1 factor is because polyhedron is fix and position is shifted.
+
+            log_io.printf(" -> (% 7.3f, % 7.3f, % 7.3f)cart. : ",
+              * pos )
+            if polyhedron.include?(pos, tolerance)
+              log_io.puts("Inside.")
+              log_io.puts("                    Found at atom with translation in internal vector [#{a}, #{b}, #{c}].")
+
+              results << Crysna::SiteWithPosition.new(
+                name,
+                Mageo::Vector3DInternal[a,b,c],
+                polyhedron.center.internal_coordinates(@axes)
+              )
+            else
+              log_io.puts("Outside.")
+            end
+          end
+        end
+      end
+
+      log_io.puts
+    end
+    return results
+  end
+
+  #Assuming a cubic cell with lattice constants of 1,1,1,90,90,90.
+  def find_nearest_frame_site(position)
+    find_site(position, @frame_sites)
+  end
+
+  def find_site(position, sites)
+    position = Mageo::Vector3D[* position]
+    position -= position.floor
+    
+    distance = 1.0/0.0
+    minimum_global_vector = [0, 0, 0]
+    minimum_site_name = nil
+    sites.each do |fsite|
+      site_name = fsite[0]
+      site_vector = fsite[1].to_v3d([[1,0,0], [0,1,0], [0,0,1]])
+
+
+      (-1).upto(1).each do |x|
+        (-1).upto(1).each do |y|
+          (-1).upto(1).each do |z|
+            tmp_vec = 
+              position - (site_vector + Mageo::Vector3D[x,y,z])
+            new_distance = tmp_vec.r
+
+            if distance > new_distance
+              minimum_global_vector = [x,y,z]
+              minimum_site_name = site_name
+              distance = new_distance
+            end
+          end
+        end
+      end
+    end
+
+    return [minimum_site_name, minimum_global_vector]
+  end
+
+  #Return a hash whose keys and values are site names and center point of polyhedra,
+  #respectively.
+  def ideal_interstitial_sites
+    results = {}
+    polyhedra.each {|name, polyhedron| results[name] = polyhedron.center.internal_coordinates(@axes)}
+    results
+  end
+
+  def polyhedra
+    tetrahedra(@tetrahedral_sites).merge(octahedra(@octahedral_sites))
+  end
+
+  private
+
+  #
+  #
+  def tetrahedra(sites)
+    results = {}
+    sites.each do |site_name, vertices|
+      coords = vertices.map do |vertex|
+        to_coord(vertex[0], vertex[1])
+      end
+      begin
+        results[site_name] = Mageo::Tetrahedron.new(coords)
+      rescue Mageo::Tetrahedron::InitializeError
+        message = "Volume of #{site_name} is zero."
+        raise SiteVolumeError , message
+      end
+    end
+    return results
+  end
+
+  def octahedra(sites)
+    results = {}
+    sites.each do |site_name, vertex_pairs|
+      coords_pairs = vertex_pairs.map do |vertex_pair|
+        vertex_pair.map{|vertex| to_coord(* vertex)}
+      end
+
+      begin
+        results[site_name] = Mageo::Octahedron.new(coords_pairs)
+      rescue Mageo::Octahedron::InitializeError
+        message = "Volume of #{site_name} is zero."
+        raise SiteVolumeError , message
+      end
+    end
+    return results
+  end
+
+  #サイト名と並進操作の組み合わせから cartesian 座標を得る。
+  def to_coord(name, translation)
+    unless @frame_sites.keys.include?(name)
+      raise NoEntrySiteError, "#{name} not in #{@frame_sites.keys}"
+    end
+    (@frame_sites[name] + Mageo::Vector3DInternal[*translation]).to_v3d(@axes)
+  end
+
+  def choose_zyx(candidates)
+    result = candidates[0]
+    candidates[1..-1].each do |site|
+      if result.coordinates[2] < site.coordinates[2] 
+        result = site
+        next
+      elsif result.coordinates[2] > site.coordinates[2] 
+        next
+      end
+
+      if result.coordinates[1] < site.coordinates[1] 
+        result = site
+        next
+      elsif result.coordinates[1] > site.coordinates[1] 
+        next
+      end
+
+      if result.coordinates[0] < site.coordinates[0] 
+        result = site
+        next
+      elsif result.coordinates[0] > site.coordinates[0] 
+        next
+      end
+      raise "Must not happen! Exist the same site?"
+    end
+    return result
+  end
+
+end
+