PFP Calculator

PFP

model_version='v3.0.0'がデフォルト値になっている.今後pfpのアップデートによりデフォルト値を変更したい場合, pfp_calculator のソースコードを変更する必要がある. もしくは次のようにmodel_versionを指定する

>>> pfp_calculator(model_version='v3.0.0')

PFPは3種類のDFT計算条件による学習データを持っています。これに対応して、計算モードと呼ばれる機能を提供しています. 計算モードを切り替えることによってどちらの学習データに合った挙動をするかを選べます。(Matlantisから引用)

  • 使用方法
    from grrmpy import pfp_calculator
    atoms.calc = pfp_calculator()
    

    これは次のコードと同じ意味である.

    from pfp_api_client.pfp.calculators.ase_calculator import ASECalculator
    from pfp_api_client.pfp.estimator import Estimator, EstimatorCalcMode
    estimator = Estimator(calc_mode=EstimatorCalcMode.CRYSTAL_PLUS_D3)
    atoms.calc = ASECalculator(estimator)
    
    pfp_api_clientから呼び出すとコード量が多くなってしまうため,GRRMPYから簡単に呼び出せるようにした.
    またclaculatorを関数化することは様々なコードを書く上でも便利になることが多い.
    例えばIRC計算でcalculatorを付ける際にpfp_api_clientの場合
    i_step = atoms0.calc =
       estimator = Estimator(calc_mode=EstimatorCalcMode.CRYSTAL_PLUS_D3)
       atoms.calc = ASECalculator(estimator)
    

計算モード

説明

CRYSTAL

結晶系(Hubbard補正あり)

MOLECULE

分子系

CRYSTAL_PLUS_D3

結晶系(Hubbard補正あり)+DFT-D3補正

CRYSTAL_U0

結晶系(Hubbard補正なし)

CRYSTAL_U0_PLUS_D3

結晶系(Hubbard補正なし)+DFT-D3補正

grrmpy.calculator.pfp_calculator(model_version='v3.0.0', calc_mode='crystal_plus_d3')[ソース]

PFP calculator

Parameters:

model_version: str

modelのバージョン

calc_mode: str
'crystal':
結晶系(Hubbard補正あり)
'crystal_plus_d3':
結晶系(Hubbard補正あり)+DFT-D3補正
'crystal_u0':
結晶系(Hubbard補正なし)
'crystal_u0_plus_d3':
結晶系(Hubbard補正なし)+DFT-D3補正
'molecule':
分子系