Gromacs  2025-dev-20240913-b871546
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Functions
gmx::anonymous_namespace{read_params.cpp} Namespace Reference

Functions

void checkMtsConsistency (const t_inputrec &inputrec, WarningHandler *wi)
 Check multiple time-stepping consistency between AWH and pull and/or FEP. More...
 
void checkPullDimParams (const std::string &prefix, const AwhDimParams &dimParams, const pull_params_t &pull_params, WarningHandler *wi)
 Check the parameters of an AWH bias pull dimension. More...
 
void checkFepLambdaDimParams (const std::string &prefix, const AwhDimParams &dimParams, const t_lambda *lambdaParams, const FreeEnergyPerturbationType efep, WarningHandler *wi)
 Check parameters of an AWH bias in a free energy lambda state dimension. More...
 
void checkFepLambdaDimDecouplingConsistency (const gmx_mtop_t &mtop, WarningHandler *wi)
 Check that AWH FEP is not combined with incompatible decoupling. More...
 
void checkDimParams (const std::string &prefix, const AwhDimParams &dimParams, const t_inputrec &ir, WarningHandler *wi)
 Check the parameters of an AWH bias dimension. More...
 
void checkBiasParams (const AwhBiasParams &awhBiasParams, const std::string &prefix, const t_inputrec &ir, WarningHandler *wi)
 Check the parameters of an AWH bias. More...
 
void checkInputConsistencyAwhBias (const AwhBiasParams &awhBiasParams, WarningHandler *wi)
 Check consistency of input at the AWH bias level. More...
 
void checkInputConsistencyAwh (const AwhParams &awhParams, WarningHandler *wi)
 Check consistency of input at the AWH level. More...
 

Function Documentation

void gmx::anonymous_namespace{read_params.cpp}::checkBiasParams ( const AwhBiasParams &  awhBiasParams,
const std::string &  prefix,
const t_inputrec &  ir,
WarningHandler wi 
)

Check the parameters of an AWH bias.

Parameters
[in]awhBiasParamsAWH dimensional parameters.
[in]prefixPrefix for bias parameters.
[in]irInput parameter struct.
[in,out]wiStruct for bookeeping warnings.
void gmx::anonymous_namespace{read_params.cpp}::checkDimParams ( const std::string &  prefix,
const AwhDimParams &  dimParams,
const t_inputrec &  ir,
WarningHandler wi 
)

Check the parameters of an AWH bias dimension.

Parameters
[in]prefixPrefix for dimension parameters.
[in,out]dimParamsAWH dimensional parameters.
[in]irInput parameter struct.
[in,out]wiStruct for bookeeping warnings.
void gmx::anonymous_namespace{read_params.cpp}::checkFepLambdaDimDecouplingConsistency ( const gmx_mtop_t &  mtop,
WarningHandler wi 
)

Check that AWH FEP is not combined with incompatible decoupling.

Parameters
[in]mtopSystem topology.
[in,out]wiStruct for bookeeping warnings.
void gmx::anonymous_namespace{read_params.cpp}::checkFepLambdaDimParams ( const std::string &  prefix,
const AwhDimParams &  dimParams,
const t_lambda *  lambdaParams,
const FreeEnergyPerturbationType  efep,
WarningHandler wi 
)

Check parameters of an AWH bias in a free energy lambda state dimension.

Parameters
[in]prefixPrefix for dimension parameters.
[in,out]dimParamsAWH dimensional parameters.
[in]lambdaParamsThe free energy lambda related parameters.
[in]efepThis is the type of FEP calculation (efep enumerator).
[in,out]wiStruct for bookeeping warnings.
void gmx::anonymous_namespace{read_params.cpp}::checkInputConsistencyAwh ( const AwhParams &  awhParams,
WarningHandler wi 
)

Check consistency of input at the AWH level.

Parameters
[in]awhParamsAWH parameters.
[in,out]wiStruct for bookkeeping warnings.
void gmx::anonymous_namespace{read_params.cpp}::checkInputConsistencyAwhBias ( const AwhBiasParams &  awhBiasParams,
WarningHandler wi 
)

Check consistency of input at the AWH bias level.

Parameters
[in]awhBiasParamsAWH bias parameters.
[in,out]wiStruct for bookkeeping warnings.
void gmx::anonymous_namespace{read_params.cpp}::checkMtsConsistency ( const t_inputrec &  inputrec,
WarningHandler wi 
)

Check multiple time-stepping consistency between AWH and pull and/or FEP.

Parameters
[in]inputrecInputput parameter struct.
[in,out]wiStruct for bookeeping warnings.
void gmx::anonymous_namespace{read_params.cpp}::checkPullDimParams ( const std::string &  prefix,
const AwhDimParams &  dimParams,
const pull_params_t &  pull_params,
WarningHandler wi 
)

Check the parameters of an AWH bias pull dimension.

Parameters
[in]prefixPrefix for dimension parameters.
[in,out]dimParamsAWH dimensional parameters.
[in]pull_paramsPull parameters.
[in,out]wiStruct for bookeeping warnings.