stormm::namelist::FFMorphControls Class Reference

Object to encapsulate force field morphing operations. Take information from an input file or a series of setters and validate each piece of data as it appears with private member functions. More...

#include <nml_ffmorph.h>

Public Member Functions
int	getEditCount (ParameterKind kind) const
	Get the number of edits for a particular force field term.
ForceFieldElement	getModelEdit (ParameterKind kind, int index) const
	Get a specific edit from within the namelist's holdings.
const NamelistEmulator &	getTranscript () const
	Get the original namelist emulator object as a transcript of the user input.
	FFMorphControls (ExceptionResponse policy_in=ExceptionResponse::DIE, WrapTextSearch wrap=WrapTextSearch::NO)
	The constructor can prepare an object with default settings or read the corresponding namelist to accept user input.
	FFMorphControls (const TextFile &tf, int *start_line, bool *found_nml, ExceptionResponse policy_in=ExceptionResponse::DIE, WrapTextSearch wrap=WrapTextSearch::NO)
	FFMorphControls (const FFMorphControls &original)=default
	As with other control objects, copy and move constructors, plus copy and move assignment operators, can all take their default forms.
	FFMorphControls (FFMorphControls &&original)=default
FFMorphControls &	operator= (const FFMorphControls &original)=default
FFMorphControls &	operator= (FFMorphControls &&original)=default

Detailed Description

Object to encapsulate force field morphing operations. Take information from an input file or a series of setters and validate each piece of data as it appears with private member functions.

Constructor & Destructor Documentation

FFMorphControls()

stormm::namelist::FFMorphControls::FFMorphControls	(	ExceptionResponse	policy_in = ExceptionResponse::DIE,
		WrapTextSearch	wrap = WrapTextSearch::NO )

The constructor can prepare an object with default settings or read the corresponding namelist to accept user input.

Parameters

tf	Input file translated into RAM
start_line	Line of the input file to begin searching for the &ffmorph namelist
found_nml	Indicator of whether namelist input was found
policy_in	Requested error handling behavior
wrap	Indicate that the search for an &ffmorph namelist should carry on from the beginning of an input file if no such namelist is found starting from the original starting point

Member Function Documentation

getEditCount()

int stormm::namelist::FFMorphControls::getEditCount

(

ParameterKind

kind

)

const

Get the number of edits for a particular force field term.

Parameters

kind	The type of force field parameter edit of interest

getModelEdit()

ForceFieldElement stormm::namelist::FFMorphControls::getModelEdit	(	ParameterKind	kind,
		int	index ) const

Get a specific edit from within the namelist's holdings.

Parameters

kind	The type of force field parameter edit of interest
index	Index of the edit from the appropriate list

---

The documentation for this class was generated from the following files:

• src/Namelists/nml_ffmorph.h
• src/Namelists/nml_ffmorph.cpp