vasputils 0.0.0

data/lib/vasputils/incar.rb

@@ -0,0 +1,55 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+# see http://cms.mpi.univie.ac.at/vasp/vasp/INCAR_File.html
+#
+# INCAR のフォーマット
+#   - 基本 1行 1項目。
+#   - = 区切りで左辺の項目名に対して右辺の値になる。
+#   - 半角＃ のあと、コメント
+#
+# TODO, Future feature
+# INCAR のフォーマット
+#   - 右辺のあとの文字列は、セミコロンでなければ無視される。
+#   - ; 区切りで1行に複数の項目を設定できる。
+#   - \ で次の行に設定を続けることができる。
+
+# Class to utilize INCAR file of VASP.
+# まず、自分で使う範囲だけ作る。
+# あとで余力があれば精密化する。
+module Incar
+	#
+	#def initialize()
+	#end
+	
+	# 与えられた IO を読み込み、INCAR として解析したハッシュを返す。
+	def self.parse(io)
+		results = {}
+		io.each_line do |line|
+			line.sub!(/\#.*/, "") # コメント文字以降を削除
+			next unless /=/ =~ line
+			if /(.*)=(.*)/ =~ line
+				key = $1.strip
+				val = $2.strip
+				val.sub!(/\s.*$/, "")
+				next if key.empty?
+				results[key] = val
+			end
+		end
+		return results
+	end
+
+	# 与えられた名前のファイルを INCAR として解析したハッシュを返す。
+	def self.load_file(file)
+		io = File.open(file, "r")
+		return self.parse(io)
+	end
+
+	## 与えられたデータ対(ハッシュ)を io に書き出す。
+	## io が nil の場合は INCAR 形式文字列を返す。
+	## (改行文字を埋め込んでおり、配列化していない)
+	#def dump(pairs, io = nil)
+	#end
+
+end
+

data/lib/vasputils/kpoints.rb

@@ -0,0 +1,41 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+# Module dearing with KPOINTS.
+module Kpoints
+	def self.parse(io)
+		results = {}
+		results[:comment] = io.readline.chomp
+
+		raise "Not automatic generating KPOINTS! 2nd line must be 0." unless io.readline == "0\n"
+
+		line = io.readline
+		case line
+		when /^m/i; then; results[:type] = :monkhorst
+		when /^g/i; then; results[:type] = :gamma_center
+		else
+			raise "Kpoints module can deal with only monkhorst and gamma-center."
+		end
+
+		#pp io.readline.strip.split(/\s+/).map{|i| i.to_i}
+		results[:mesh] = io.readline.strip.split(/\s+/).map{|i| i.to_i}
+		#pp io.readline.strip.split(/\s+/).map{|i| i.to_f}
+		results[:shift] = io.readline.strip.split(/\s+/).map{|i| i.to_f}
+
+		return results
+	end
+
+	# 
+	def self.load_file(file)
+		self.parse(File.open(file, "r"))
+	end
+
+	def self.dump(data, io)
+		io.puts "Automatic mesh"
+		io.puts "0"
+		io.puts data[:type].to_s.capitalize
+		io.puts data[:mesh].join(" ")
+		io.puts data[:shift].join(" ")
+	end
+end
+

data/lib/vasputils/outcar.rb

@@ -0,0 +1,59 @@
+# OUTCAR をパースする。
+# 精確には行わず、必要な情報だけをピックアップする感じ。
+#
+# あまり頑張らないことにした理由は以下。
+#   OUTCAR がどう出力されるのかがよくわからない。
+#   本来は vasp のソースを見て決めるべきだろう。
+#   やるとすればかなり大掛かりなプロジェクトになるが、そのわりには旨味が少ない。
+#   grep でなんとかなるし。
+#
+# 基本的に終了した計算から情報を取り出すには vasprun.xml を読む。
+# OUTCAR は終了する前も含めてなんか簡単に見るために使う、という位置付けで。
+
+module Outcar
+	#toten は全 electronic and ionic steps のを flat に並べただけのもの。
+	#必要なら構造化するが、現状その予定はない。
+	#attr_reader :name
+	#attr_reader :ionic_steps, :electronic_steps, :totens, :volumes, :elapsed_time
+
+	def self.load_file(file)
+		results = {}
+		results[:name] = file
+		results[:irreducible_kpoints] = nil
+		results[:electronic_steps   ] = 0
+		results[:ionic_steps        ] = 0
+		results[:totens             ] = []
+		results[:volumes            ] = []
+		results[:elapsed_time       ] = nil
+		results[:normal_ended       ] = false
+
+		lines = File.readlines(file)
+		lines.each do |line|
+			if /Found\s+(\d+)\s+irreducible k-points/i =~ line
+				results[:irreducible_kpoints] = $1.to_i
+			end
+
+			if /^-* Iteration\s+(\d+)/ =~ line
+				results[:ionic_steps     ] = $1.to_i
+				results[:electronic_steps] += 1
+			end
+
+			#if /free\s+energy\s+TOTEN\s+=\s(.*)\s+eV/ =~ line
+			if /TOTEN\s+=\s(.*)\s+eV/ =~ line
+				results[:totens] << $1.to_f
+			end
+
+			if /volume of cell :\s+(\d+\.\d+)$/ =~ line
+				results[:volumes] << $1.to_f
+			end
+
+			if (/Elapsed time \(sec\):\s+(\d+\.\d+)/ =~ line)
+				results[:elapsed_time] = $1.to_f
+			end
+		end
+
+		results[:normal_ended] = true if (/Voluntary context switches:/ =~ lines[-1])
+
+		results
+	end
+end

data/lib/vasputils/poscar.rb

@@ -0,0 +1,168 @@
+#! /usr/bin/ruby
+
+require "rubygems"
+gem "crystalcell"
+require "crystalcell/cell.rb"
+
+# Class to manage POSCAR format of VASP.
+# 
+# parse と dump のどちらかだけでなく、両方を統括して扱うクラス。
+#
+# MEMO
+# POSCAR 自身は元素の情報を持っていない。
+# POSCAR が native に持っている情報だけを取り扱う。
+# Poscar では個々の原子が何の element であるかという情報を取り扱わない。
+# 1番目の種類の原子種が何かだけを扱う。
+# こうしておくことで POTCAR がない環境でも POSCAR を扱うことができる。
+#
+# VASP 5 系を使うようになれば事情が変わるだろう。
+class Poscar
+
+	class ElementMismatchError < Exception; end
+	class ParseError < Exception; end
+
+	# io を読み込んで Cell クラスインスタンスを返す。
+	# 構文解析できなければ例外 Poscar::ParseError を投げる。
+	def self.parse(io)
+		# analyze POSCAR.
+
+		begin
+			#line 1: comment (string)
+			comment = io.readline.chomp
+
+			#line 2: universal scaling factor (float)
+			scale = io.readline.to_f
+			raise "Poscar.load_file cannot use negative scaling factor.\n" if scale < 0
+
+			#line 3-5: axes (3x3 Array of float)
+			axes = []
+			3.times do |i| #each axis of a, b, c.
+				vec = io.readline.strip.split(/\s+/) #in x,y,z directions
+				axes << vec.collect! { |i| i.to_f * scale } #multiply scaling factor
+			end
+
+			#line 6: numbers of elements. e.g.,[1, 1, 2]
+			nums_elements = io.readline.strip.split( /\s+/ ).map{|i| i.to_i}
+
+			#line 7-(8): 'Selective dynamics' or not (bool)
+			line = io.readline
+			if line =~ /^\s*s/i
+				selective_dynamics = true
+				line = io.readline    # when this situation, reading one more line is nessesarry
+			end
+
+			if (line =~ /^\s*d/i ) # allow only 'Direct' now
+				direct = true
+			else
+				raise "Not 'direct' indication."
+			end
+
+			#line 9(8): position
+			#e.g., positions_of_elements
+			#e.g., movable_flags_of_elements
+
+			atoms = []
+			nums_elements.size.times do |elem_index|
+				nums_elements[elem_index].times do |index|
+				items = io.readline.strip.split( /\s+/ )
+				pos = items[0..2].map {|coord| coord.to_f}
+				#pp pos
+
+				mov_flags = []
+				if items.size >= 6 then
+					items[3..5].each do |i|
+						( i =~ /^t/i ) ? mov_flags << true : mov_flags << false
+					end
+					atoms << Atom.new(elem_index, pos, mov_flags)
+				else
+					atoms << Atom.new(elem_index, pos)
+				end
+				end
+			end
+		rescue EOFError
+			raise ParseError, "end of file reached"
+		end
+
+		cell = Cell.new(axes, atoms )
+		cell.comment = comment
+		cell
+	end
+
+	# file で与えられた名前のファイルを読み込んで Cell クラスインスタンスを返す。
+	# 構文解析できなければ例外 Poscar::ParseError を投げる。
+	def self.load_file(file)
+		io = File.open(file, "r")
+		self.parse(io)
+	end
+
+	# POSCAR 形式で書き出す。
+	# cell は Cell クラスインスタンスと同等のメソッドを持つもの。
+	# elems は書き出す元素の順番。
+	# 	elems が cell の持つ元素リストとマッチしなければ
+	# 	例外 Poscar::ElementMismatchError を投げる。
+	# io は書き出すファイルハンドル。
+	def self.dump(cell, elems, io)
+		unless (Mapping::map?(cell.elements.uniq, elems){ |i, j| i == j })
+			raise ElementMismatchError,
+			"elems [#{elems.join(",")}] mismatches to cell.elements [#{cell.elements.join(",")}."
+		end
+
+		io.puts cell.comment
+		io.puts "1.0" #scale
+		3.times do |i|
+			io.printf( "  % 18.15f  % 18.15f  % 18.15f\n", cell.axes[i][0], cell.axes[i][1], cell.axes[i][2]
+			)
+		end
+
+		# collect information
+		elem_list = Hash.new
+		elems.each do |elem|
+			elem_list[ elem ] = cell.atoms.select{ |atom| atom.element == elem }
+		end
+		io.puts(elems.map { |elem| elem_list[elem].size }.join(" "))
+
+		# Selective dynamics
+		# どれか1つでも getMovableFlag が真であれば Selective dynamics をオンにする
+		selective_dynamics = false
+		cell.atoms.each do |atom|
+			if atom.movable_flags
+				selective_dynamics = true
+				io.puts "Selective dynamics"
+				break
+			end
+		end
+
+		elems.each do |elem|
+			elem_list[ elem ].each do |atom|
+				if atom.movable_flags
+					selective_dynamics = true
+					break
+				end
+			end
+			break if selective_dynamics
+		end
+
+		io.puts "Direct"
+
+		# positions of atoms
+		elems.each do |elem|
+			elem_list[ elem ].each do |atom|
+				tmp =  sprintf(
+					"  % 18.15f  % 18.15f  % 18.15f",
+					* atom.position )
+				if selective_dynamics
+					if atom.movable_flags == nil
+						tmp += " T T T"
+					else
+						atom.movable_flags.each do |mov|
+							( mov == true ) ?  tmp += " T" : tmp += " F"
+						end
+					end
+				end
+				io.puts tmp
+			end
+		end
+	end
+
+end
+

data/lib/vasputils/potcar.rb

@@ -0,0 +1,18 @@
+#
+# Class for dealing with POTCAR.
+#
+module Potcar
+	def self.load_file(file)
+		results = {}
+		results[:name] = file
+
+		elements = Array.new
+		File.open( file, "r" ).each do |line|
+			if line =~ /VRHFIN\s*=\s*([A-Za-z]*)/
+				elements << $1
+			end
+		end
+		results[:elements] = elements
+		results
+	end
+end

data/lib/vasputils/vaspdir.rb

@@ -0,0 +1,278 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+require "vasputils/incar.rb"
+require "vasputils/outcar.rb"
+require "vasputils/poscar.rb"
+require "vasputils/kpoints.rb"
+require "fileutils"
+require "pp"
+require "date"
+
+
+# vasp 実行ディレクトリ(入力・出力ファイルを含む)を扱うクラス
+#
+# MEMO
+# interrupted? みたいなメソッドは作れない。
+# 実行が開始したあと、その計算の状態が中断されているのか、
+# 単に実行中でファイルが書き込まれている途中なのか、
+# プログラムを実行しているプロセス自身以外は、外部からは判別がつかない。
+#
+# ルール
+# try00 形式の postfix がついていることを前提とする。
+# 00 の部分には CONTCAR を POSCAR にする手続きで連続して行う計算の番号を示す。
+#
+class VaspDir
+
+	class InitializeError < Exception; end
+	class ConvergedError < Exception; end
+	class NotEndedError < Exception; end
+	class LockedError < Exception; end
+	class PostfixMismatchError < Exception; end
+
+
+	LOCK_FILE = "lock"
+	POSTFIX = /try(\d+)$/
+
+	YET         = 0# - 未計算。
+	STARTED     = 1# - 開始した。
+	INTERRUPTED = 2# - 中断された。
+	CONTINUED   = 3# - 終了し、次の計算を生成した。
+	COMPLETED   = 4# - 終了し、収束した。
+
+	attr_reader :mode
+	#attr_reader :dir
+
+	#INCAR 解析とかして、モードを調べる。
+	#- 格子定数の構造最適化モード(ISIF = 3)
+	#- 格子定数を固定した構造最適化モード(ISIF = 2)
+	##- k 点探索モードは無理だろう。
+	def initialize(dir_name)
+		@dir = dir_name
+
+		%w(INCAR KPOINTS POSCAR POTCAR).each do |file|
+			infile = "#{@dir}/#{file}"
+			raise InitializeError, infile unless FileTest.exist? infile
+		end
+
+		@incar = Incar.load_file("#{@dir}/INCAR")
+		case @incar["IBRION"]
+		when "-1"
+			@mode = :single_point
+		#when "1"
+		#	@mode = :molecular_dynamics
+		when "2"
+			if (@incar["ISIF"] == "2")
+				@mode = :geom_opt_atoms
+			elsif (@incar["ISIF"] == "3")
+				@mode = :geom_opt_lattice
+			else
+				@mode = :geom_opt
+			end
+		else
+				@mode = nil
+		end
+	end
+
+	# ディレクトリ名を返す。
+	def name
+		@dir
+	end
+
+	# 計算が過去に始まっていれば true を返す。
+	# 終わっているかは判定しない。
+	# 具体的には lock ファイルが存在すれば true を返す。
+	#
+	# MEMO
+	# (mpi 経由で？)vasp を実行すると PI12345 とかいうファイルができるが、
+	# これはたぶん起動してから若干のタイムラグが生じる。
+	# このタイムラグ中に別のプロセスが同時に計算したらマズい。
+	def started?
+		return File.exist? lock_file
+	end
+
+	# 正常に終了していれば true を返す。
+	# 実行する前や実行中、OUTCAR が完遂していなければ false。
+	#
+	# MEMO
+	# PI12345 ファイルは実行中のみ存在し、終了後 vasp (mpi？) に自動的に削除される。
+	def normal_ended?
+		begin
+			return Outcar.load_file("#{@dir}/OUTCAR")[:normal_ended]
+		rescue Errno::ENOENT
+			return false
+		end
+	end
+
+	# normal_ended? が false なら false。
+	# normal_ended? が true のうち、
+	# 結果を使って次に計算すべきなら true を、そうでなければ false を返す。
+	#
+	# 計算すべき、の条件はモードによって異なる。
+	#   NSW = 0 もしくは NSW = 1 のとき、必ず false。
+	#   - :single_point     モードならば、常に false。
+	#   - :geom_opt_lattice モードならば、ionic step が 2 以上なら true。
+	#   - :geom_opt_atoms   モードならば、ionic step が NSW と同じなら true。
+	#
+	def to_be_continued?
+		begin
+			outcar = Outcar.load_file("#{@dir}/OUTCAR")
+		rescue Errno::ENOENT
+			return false
+		end
+		ionic_steps = outcar[:ionic_steps]
+		return false unless outcar[:normal_ended]
+		return false if @incar["NSW"].to_i <= 1
+		if @mode == :geom_opt_lattice
+			return ionic_steps != 1
+		elsif @mode == :geom_opt_atoms
+			return ionic_steps == @incar["NSW"].to_i
+		else
+			return false
+		end
+	end
+
+	# vasp を投げる。
+	# 計算実行時に lock を生成する。
+	# もし既に lock が存在していれば、例外 VaspDirLockedError を
+	# 投げる。
+	# lock は作られっぱなしで、プログラムからは削除されない。
+	# 通常、一度計算したらもう二度と計算しないし。
+	#
+	# MEMO
+	# mpirun で投げる場合は
+	# machinefile を生成しないとどのホストで計算するか、安定しない。
+	# そのうち mpiexec from torque に対応するが、
+	# まずは mpirun で動くように作る。
+	def calculate
+		raise LockedError if started?
+
+		File.open(lock_file, "w") do |lock_io|
+			lock_io.puts "HOST: #{ENV["HOST"]}"
+			lock_io.puts "START: #{Time.now.to_s}"
+			lock_io.flush
+
+			num_cores = 4 if /^Se\d\d/ =~ ENV["HOST"]
+			num_cores = 4 if /^Ge\d\d/ =~ ENV["HOST"]
+			num_cores = 4 if /^Ga\d\d/ =~ ENV["HOST"]
+			num_cores = 4 if /^At$/ =~ ENV["HOST"]
+			num_cores = 2 if /^yggdrasil$/ =~ ENV["HOST"]
+
+			# machines を生成
+			File.open("#{@dir}/machines", "w") do |io|
+				io.puts "localhost:#{num_cores}"
+			end
+
+			command = "cd #{@dir};" +
+				"/usr/local/calc/mpich-1.2.7-ifc7/bin/mpirun " +
+				"-np #{num_cores} " +
+				"-machinefile machines " +
+				"/usr/local/calc/vasp/vasp4631mpi" +
+				"> stdout"
+
+			if $TEST
+				generated_files = [
+					"CHG",
+					"CHGCAR",
+					"CONTCAR",
+					"DOSCAR",
+					"EIGENVAL",
+					"IBZKPT",
+					"OSZICAR",
+					"OUTCAR",
+					"PCDAT",
+					"WAVECAR",
+					"XDATCAR",
+					"machines",
+					"vasprun.xml",
+					"lock",
+				]
+				generated_files.map!{|i| "#{@dir}/#{i}"}
+				command = "touch #{generated_files.join(" ")}"
+			end
+
+			status = system command
+			if status
+				lock_io.puts "STATUS: normal ended."
+			else
+				lock_io.puts "STATUS: irregular ended, status #{$?}."
+			end
+		end
+	end
+
+	# 次の計算ディレクトリを作成し、
+	# その VaspDir クラスで self を置き換える。
+	# 計算が正常終了していなければ、例外 VaspDirNotEndedError を生じる。
+	# 次の計算ディレクトリが既に存在していれば例外 Errno::EEXIST が投げられる。
+	def next
+		raise NotEndedError unless normal_ended?
+		raise ConvergedError unless to_be_continued?
+		#postfix = /try(\d+)$/
+		POSTFIX =~ @dir
+		try_num = $1.to_i
+		next_dir = @dir.sub(POSTFIX, sprintf("try%02d", try_num + 1))
+		Dir.mkdir next_dir
+		FileUtils.cp( "#{@dir}/INCAR"  , "#{next_dir}/INCAR")
+		FileUtils.cp( "#{@dir}/KPOINTS", "#{next_dir}/KPOINTS")
+		FileUtils.cp( "#{@dir}/POTCAR" , "#{next_dir}/POTCAR")
+		FileUtils.cp( "#{@dir}/CONTCAR", "#{next_dir}/POSCAR")
+		initialize(next_dir)
+	end
+
+	# Postprocess.
+	def teardown
+		# Do nothing.
+	end
+
+	# Return number of electronic steps.
+	def internal_steps
+		return outcar[:electronic_steps] if outcar
+		return 0
+	end
+
+	# Return number of ionic steps.
+	def external_steps
+		return outcar[:ionic_steps] if outcar
+		return 0
+	end
+
+	# Return elapsed time.
+	def elapsed_time
+		return outcar[:elapsed_time] if outcar
+		return 0.0
+	end
+
+	# 配下の OUTCAR を Outcar インスタンスにして返す。
+	# 存在しなければ例外 Errno::ENOENT を返す。
+	def outcar
+		Outcar.load_file("#{@dir}/OUTCAR")
+	end
+
+	# 配下の CONTCAR を Cell2 インスタンスにして返す。
+	# 存在しなければ例外 Errno::ENOENT を返す。
+	def contcar
+		Poscar.load_file("#{@dir}/CONTCAR")
+	end
+
+	# 配下の KPOINTS を読み込んだ結果をハッシュにして返す。
+	#
+	# 存在しなければ例外 Errno::ENOENT を返す筈だが、
+	# vasp dir の判定を incar でやっているので置こる筈がない。
+	def incar
+		Incar.load_file("#{@dir}/INCAR")
+	end
+
+	# 配下の KPOINTS を読み込んだ結果をハッシュにして返す。
+	def kpoints
+		Kpoints.load_file("#{@dir}/KPOINTS")
+	end
+
+	private
+
+	# Return lock file name.
+	def lock_file
+		return "#{@dir}/#{LOCK_FILE}"
+	end
+
+end
+

data/test/calcseries/dup_finished/try00/CONTCAR

@@ -0,0 +1,17 @@
+Untitled (VASP)                         
+   1.00000000000000     
+     3.6218218384059248   -0.0000000000000001    0.0000000000000000
+    -1.8109109192029544    3.1365897200407926    0.0000000000000000
+     0.0000000000000000    0.0000000000000000    3.8586803850215405
+   3   1
+Selective dynamics
+Direct
+  0.0000000000000000  0.0000000000000000  0.5000000000000000   T   T   T
+  0.3333333333333357  0.6666666666666642  0.0000000000000000   T   T   T
+  0.6666666666666642  0.3333333333333357  0.0000000000000000   T   T   T
+  0.0000000000000000  0.0000000000000000  0.0000000000000000   F   F   F
+ 
+  0.00000000E+00  0.00000000E+00  0.00000000E+00
+  0.00000000E+00  0.00000000E+00  0.00000000E+00
+  0.00000000E+00  0.00000000E+00  0.00000000E+00
+  0.00000000E+00  0.00000000E+00  0.00000000E+00

data/test/calcseries/dup_finished/try00/INCAR

@@ -0,0 +1,28 @@
+# SCF input for VASP
+
+SYSTEM = Untitled (VASP)
+    PREC = High
+  IBRION = 2        #-1:atoms not moved, 1:quasi-Newton, 2:conjugate-gradient
+     NSW = 3        #maximum number of ionic steps
+    ISIF = 2
+   ENCUT = 400
+    NELM = 60       #maximum number of electronic steps
+  NELMIN = 2        #minimum number of electronic steps
+   EDIFF = 1.0e-05
+  EDIFFG = -0.02
+ VOSKOWN = 1
+  NBLOCK = 1
+   ISPIN = 1        #1:non spin polarized, 2:spin polarized
+  INIWAV = 1
+  ISTART = 1
+  ICHARG = 1
+   LWAVE = .TRUE.
+  LCHARG = .TRUE.
+  ISMEAR = 0
+   SIGMA = 0.1
+   IALGO = 38       #38:KosugiAlgorithm, 48:RMM-DIIS
+   #LREAL = .FALSE.
+   LREAL = Auto     #fast & not accurate
+     NGX = 36
+     NGY = 36
+     NGZ = 42

data/test/calcseries/dup_finished/try00/KPOINTS

@@ -0,0 +1,6 @@
+Automatic mesh
+0
+Monkhorst Pack
+  5  5  5
+  0.  0.  0.
+