Detailed Description
template<class Interaction>
class McMd::ExternalPotentialImpl< Interaction >
Template implementation of ExternalPotential.
Definition at line 35 of file mcMd/potentials/external/ExternalPotentialImpl.h.
#include <ExternalPotentialImpl.h>
Public Member Functions | |
| ExternalPotentialImpl (System &system) | |
| Constructor. More... | |
| ExternalPotentialImpl (ExternalPotentialImpl< Interaction > &other) | |
| Constructor (copied from ExternalPotential) More... | |
| virtual | ~ExternalPotentialImpl () |
| Destructor. More... | |
| virtual void | readParameters (std::istream &in) |
| Read param for external potential. More... | |
| virtual void | loadParameters (Serializable::IArchive &ar) |
| Load internal state from an archive. More... | |
| virtual void | save (Serializable::OArchive &ar) |
| Save internal state to an archive. More... | |
| Interaction & | interaction () |
| Return external interaction by reference. More... | |
| const Interaction & | interaction () const |
| Return external interaction by const reference. More... | |
Interaction interface | |
| virtual double | energy (const Vector &position, int typeId) const |
| Returns external potential energy of a single particle. More... | |
| virtual void | getForce (const Vector &position, int typeId, Vector &force) const |
| Returns force caused by the external potential. More... | |
| virtual std::string | interactionClassName () const |
| Return external interaction class name (e.g., "LamellarOrderingExternal"). More... | |
System energy and force calculators | |
| void | addForces () |
| Add external force of an Atom to the total force acting on it. More... | |
| void | computeEnergy () |
| Compute and store total external energy of this System. More... | |
| double | atomEnergy (const Atom &atom) const |
| Calculate the external energy for one Atom. More... | |
 Public Member Functions inherited from McMd::ExternalPotential | |
| ExternalPotential () | |
| Constructor . More... | |
| virtual | ~ExternalPotential () |
| Destructor (does nothing) More... | |
| Public Member Functions inherited from Util::ParamComposite | |
| ParamComposite () | |
| Constructor. More... | |
| ParamComposite (const ParamComposite &other) | |
| Copy constructor. More... | |
| ParamComposite (int capacity) | |
| Constructor. More... | |
| virtual | ~ParamComposite () |
| Virtual destructor. More... | |
| void | resetParam () |
| Resets ParamComposite to its empty state. More... | |
| virtual void | readParam (std::istream &in) |
| Read the parameter file block. More... | |
| virtual void | readParamOptional (std::istream &in) |
| Read optional parameter file block. More... | |
| virtual void | writeParam (std::ostream &out) |
| Write all parameters to an output stream. More... | |
| virtual void | load (Serializable::IArchive &ar) |
| Load all parameters from an input archive. More... | |
| virtual void | loadOptional (Serializable::IArchive &ar) |
| Load an optional ParamComposite. More... | |
| void | saveOptional (Serializable::OArchive &ar) |
| Saves isActive flag, and then calls save() iff isActive is true. More... | |
| void | readParamComposite (std::istream &in, ParamComposite &child, bool next=true) |
| Add and read a required child ParamComposite. More... | |
| void | readParamCompositeOptional (std::istream &in, ParamComposite &child, bool next=true) |
| Add and attempt to read an optional child ParamComposite. More... | |
| template<typename Type > | |
| ScalarParam< Type > & | read (std::istream &in, const char *label, Type &value) |
| Add and read a new required ScalarParam < Type > object. More... | |
| template<typename Type > | |
| ScalarParam< Type > & | readOptional (std::istream &in, const char *label, Type &value) |
| Add and read a new optional ScalarParam < Type > object. More... | |
| template<typename Type > | |
| CArrayParam< Type > & | readCArray (std::istream &in, const char *label, Type *value, int n) |
| Add and read a required C array parameter. More... | |
| template<typename Type > | |
| CArrayParam< Type > & | readOptionalCArray (std::istream &in, const char *label, Type *value, int n) |
| Add and read an optional C array parameter. More... | |
| template<typename Type > | |
| DArrayParam< Type > & | readDArray (std::istream &in, const char *label, DArray< Type > &array, int n) |
| Add and read a required DArray < Type > parameter. More... | |
| template<typename Type > | |
| DArrayParam< Type > & | readOptionalDArray (std::istream &in, const char *label, DArray< Type > &array, int n) |
| Add and read an optional DArray < Type > parameter. More... | |
| template<typename Type , int N> | |
| FArrayParam< Type, N > & | readFArray (std::istream &in, const char *label, FArray< Type, N > &array) |
| Add and read a required FArray < Type, N > array parameter. More... | |
| template<typename Type , int N> | |
| FArrayParam< Type, N > & | readOptionalFArray (std::istream &in, const char *label, FArray< Type, N > &array) |
| Add and read an optional FArray < Type, N > array parameter. More... | |
| template<typename Type > | |
| CArray2DParam< Type > & | readCArray2D (std::istream &in, const char *label, Type *value, int m, int n, int np) |
| Add and read a required CArray2DParam < Type > 2D C-array. More... | |
| template<typename Type > | |
| CArray2DParam< Type > & | readOptionalCArray2D (std::istream &in, const char *label, Type *value, int m, int n, int np) |
| Add and read an optional CArray2DParam < Type > 2D C-array parameter. More... | |
| template<typename Type > | |
| DMatrixParam< Type > & | readDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n) |
| Add and read a required DMatrix < Type > matrix parameter. More... | |
| template<typename Type > | |
| DMatrixParam< Type > & | readOptionalDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n) |
| Add and read an optional DMatrix < Type > matrix parameter. More... | |
| template<typename Type > | |
| DSymmMatrixParam< Type > & | readDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n) |
| Add and read a required symmetrix DMatrix. More... | |
| template<typename Type > | |
| DSymmMatrixParam< Type > & | readOptionalDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n) |
| Add and read an optional DMatrix matrix parameter. More... | |
| Begin & | readBegin (std::istream &in, const char *label, bool isRequired=true) |
| Add and read a class label and opening bracket. More... | |
| End & | readEnd (std::istream &in) |
| Add and read the closing bracket. More... | |
| Blank & | readBlank (std::istream &in) |
| Add and read a new Blank object, representing a blank line. More... | |
| void | loadParamComposite (Serializable::IArchive &ar, ParamComposite &child, bool next=true) |
| Add and load a required child ParamComposite. More... | |
| void | loadParamCompositeOptional (Serializable::IArchive &ar, ParamComposite &child, bool next=true) |
| Add and load an optional child ParamComposite if isActive. More... | |
| template<typename Type > | |
| ScalarParam< Type > & | loadParameter (Serializable::IArchive &ar, const char *label, Type &value, bool isRequired) |
| Add and load a new ScalarParam < Type > object. More... | |
| template<typename Type > | |
| ScalarParam< Type > & | loadParameter (Serializable::IArchive &ar, const char *label, Type &value) |
| Add and load new required ScalarParam < Type > object. More... | |
| template<typename Type > | |
| CArrayParam< Type > & | loadCArray (Serializable::IArchive &ar, const char *label, Type *value, int n, bool isRequired) |
| Add a C array parameter and load its elements. More... | |
| template<typename Type > | |
| CArrayParam< Type > & | loadCArray (Serializable::IArchive &ar, const char *label, Type *value, int n) |
| Add and load a required CArrayParam< Type > array parameter. More... | |
| template<typename Type > | |
| DArrayParam< Type > & | loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n, bool isRequired) |
| Add an load a DArray < Type > array parameter. More... | |
| template<typename Type > | |
| DArrayParam< Type > & | loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n) |
| Add and load a required DArray< Type > array parameter. More... | |
| template<typename Type , int N> | |
| FArrayParam< Type, N > & | loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array, bool isRequired) |
| Add and load an FArray < Type, N > fixed-size array parameter. More... | |
| template<typename Type , int N> | |
| FArrayParam< Type, N > & | loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array) |
| Add and load a required FArray < Type > array parameter. More... | |
| template<typename Type > | |
| CArray2DParam< Type > & | loadCArray2D (Serializable::IArchive &ar, const char *label, Type *value, int m, int n, int np, bool isRequired) |
| Add and load a CArray2DParam < Type > C 2D array parameter. More... | |
| template<typename Type > | |
| CArray2DParam< Type > & | loadCArray2D (Serializable::IArchive &ar, const char *label, Type *value, int m, int n, int np) |
| Add and load a required < Type > matrix parameter. More... | |
| template<typename Type > | |
| DMatrixParam< Type > & | loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired) |
| Add and load a DMatrixParam < Type > matrix parameter. More... | |
| template<typename Type > | |
| DMatrixParam< Type > & | loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n) |
| Add and load a required DMatrixParam < Type > matrix parameter. More... | |
| template<typename Type > | |
| DSymmMatrixParam< Type > & | loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n, bool isRequired) |
| Add and load a symmetric DSymmMatrixParam < Type > matrix parameter. More... | |
| template<typename Type > | |
| DSymmMatrixParam< Type > & | loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n) |
| Add and load a required DSymmMatrixParam < Type > matrix parameter. More... | |
| void | addParamComposite (ParamComposite &child, bool next=true) |
| Add a child ParamComposite object to the format array. More... | |
| Begin & | addBegin (const char *label) |
| Add a Begin object representing a class name and bracket. More... | |
| End & | addEnd () |
| Add a closing bracket. More... | |
| Blank & | addBlank () |
| Create and add a new Blank object, representing a blank line. More... | |
| std::string | className () const |
| Get class name string. More... | |
| bool | isRequired () const |
| Is this ParamComposite required in the input file? More... | |
| bool | isActive () const |
| Is this parameter active? More... | |
| Public Member Functions inherited from Util::ParamComponent | |
| virtual | ~ParamComponent () |
| Destructor. More... | |
| void | setIndent (const ParamComponent &parent, bool next=true) |
| Set indent level. More... | |
| std::string | indent () const |
| Return indent string for this object (string of spaces). More... | |
| template<class Archive > | |
| void | serialize (Archive &ar, const unsigned int version) |
| Serialize this ParamComponent as a string. More... | |
| Public Member Functions inherited from Util::Serializable | |
| virtual | ~Serializable () |
| Destructor. More... | |
| Public Member Functions inherited from Util::MpiFileIo | |
| MpiFileIo () | |
| Constructor. More... | |
| MpiFileIo (const MpiFileIo &other) | |
| Copy constructor. More... | |
| bool | isIoProcessor () const |
| Can this processor do file I/O ? More... | |
| void | setIoCommunicator (MPI::Intracomm &communicator) |
| Set the communicator. More... | |
| void | clearCommunicator () |
| Clear (nullify) the communicator. More... | |
| bool | hasIoCommunicator () const |
| Does this object have an associated MPI communicator? More... | |
| MPI::Intracomm & | ioCommunicator () const |
| Get the MPI communicator by reference. More... | |
| Public Member Functions inherited from McMd::EnergyCalculator | |
| virtual void | unsetEnergy () |
| Mark the energy as unknown. More... | |
| double | energy () |
| Return the energy contribution, compute if necessary. More... | |
Additional Inherited Members | |
| Public Types inherited from Util::Serializable | |
| typedef BinaryFileOArchive | OArchive |
| Type of output archive used by save method. More... | |
| typedef BinaryFileIArchive | IArchive |
| Type of input archive used by load method. More... | |
| Static Public Member Functions inherited from Util::ParamComponent | |
| static void | initStatic () |
| Initialize static echo member to false. More... | |
| static void | setEcho (bool echo=true) |
| Enable or disable echoing for all subclasses of ParamComponent. More... | |
| static bool | echo () |
| Get echo parameter. More... | |
| Protected Member Functions inherited from Util::ParamComposite | |
| void | setClassName (const char *className) |
| Set class name string. More... | |
| void | setIsRequired (bool isRequired) |
| Set or unset the isActive flag. More... | |
| void | setIsActive (bool isActive) |
| Set or unset the isActive flag. More... | |
| void | setParent (ParamComponent ¶m, bool next=true) |
| Set this to the parent of a child component. More... | |
| void | addComponent (ParamComponent ¶m, bool isLeaf=true) |
| Add a new ParamComponent object to the format array. More... | |
| template<typename Type > | |
| ScalarParam< Type > & | add (std::istream &in, const char *label, Type &value, bool isRequired=true) |
| Add a new required ScalarParam < Type > object. More... | |
| template<typename Type > | |
| CArrayParam< Type > & | addCArray (std::istream &in, const char *label, Type *value, int n, bool isRequired=true) |
| Add (but do not read) a required C array parameter. More... | |
| template<typename Type > | |
| DArrayParam< Type > & | addDArray (std::istream &in, const char *label, DArray< Type > &array, int n, bool isRequired=true) |
| Add (but do not read) a DArray < Type > parameter. More... | |
| template<typename Type , int N> | |
| FArrayParam< Type, N > & | addFArray (std::istream &in, const char *label, FArray< Type, N > &array, bool isRequired=true) |
| Add (but do not read) a FArray < Type, N > array parameter. More... | |
| template<typename Type > | |
| CArray2DParam< Type > & | addCArray2D (std::istream &in, const char *label, Type *value, int m, int n, int np, bool isRequired=true) |
| Add (but do not read) a CArray2DParam < Type > 2D C-array. More... | |
| template<typename Type > | |
| DMatrixParam< Type > & | addDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired=true) |
| Add and read a required DMatrix < Type > matrix parameter. More... | |
| Protected Member Functions inherited from Util::ParamComponent | |
| ParamComponent () | |
| Constructor. More... | |
| ParamComponent (const ParamComponent &other) | |
| Copy constructor. More... | |
Constructor & Destructor Documentation
| McMd::ExternalPotentialImpl< Interaction >::ExternalPotentialImpl | ( | System & | system | ) |
Constructor.
Definition at line 172 of file mcMd/potentials/external/ExternalPotentialImpl.h.
| McMd::ExternalPotentialImpl< Interaction >::ExternalPotentialImpl | ( | ExternalPotentialImpl< Interaction > & | other | ) |
Constructor (copied from ExternalPotential)
Definition at line 183 of file mcMd/potentials/external/ExternalPotentialImpl.h.
|
virtual |
Destructor.
Definition at line 195 of file mcMd/potentials/external/ExternalPotentialImpl.h.
Member Function Documentation
|
virtual |
Read param for external potential.
This method reads the external potential Interaction parameter block. Before calling Interaction::readParameters(), it passes simulation().nExternalType() to Interaction::setNAtomType().
Reimplemented from Util::ParamComposite.
Definition at line 202 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References Util::ParamComposite::addParamComposite(), McMd::SystemInterface::boundary(), McMd::ExternalPotentialImpl< Interaction >::interaction(), McMd::SystemInterface::simulation(), and McMd::SystemInterface::system().
|
virtual |
Load internal state from an archive.
- Parameters
-
ar input/loading archive
Reimplemented from Util::ParamComposite.
Definition at line 219 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References Util::ParamComposite::addParamComposite(), McMd::ExternalPotentialImpl< Interaction >::interaction(), and McMd::SystemInterface::simulation().
|
virtual |
Save internal state to an archive.
- Parameters
-
ar output/saving archive
Reimplemented from Util::ParamComposite.
Definition at line 234 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References McMd::ExternalPotentialImpl< Interaction >::interaction().
|
virtual |
Returns external potential energy of a single particle.
- Parameters
-
position atomic position Vector typeId atom type index
- Returns
- external potential energy
Implements McMd::ExternalPotential.
Definition at line 247 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References McMd::ExternalPotentialImpl< Interaction >::interaction().
|
virtual |
Returns force caused by the external potential.
- Parameters
-
position atom position typeId atom type index force force on the atom (on output)
Implements McMd::ExternalPotential.
Definition at line 255 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References McMd::ExternalPotentialImpl< Interaction >::interaction().
|
virtual |
Return external interaction class name (e.g., "LamellarOrderingExternal").
Implements McMd::ExternalPotential.
Definition at line 321 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References McMd::ExternalPotentialImpl< Interaction >::interaction().
|
virtual |
Add external force of an Atom to the total force acting on it.
Implements McMd::ExternalPotential.
Definition at line 263 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References McMd::SystemInterface::begin(), McMd::ExternalPotentialImpl< Interaction >::interaction(), Util::ArrayIterator< Data >::notEnd(), Util::PArrayIterator< Data >::notEnd(), McMd::Simulation::nSpecies(), and McMd::SystemInterface::simulation().
|
virtual |
Compute and store total external energy of this System.
Implements McMd::EnergyCalculator.
Definition at line 283 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References McMd::SystemInterface::begin(), McMd::EnergyCalculator::energy(), McMd::ExternalPotentialImpl< Interaction >::interaction(), Util::ConstArrayIterator< Data >::notEnd(), Util::ConstPArrayIterator< Data >::notEnd(), McMd::Simulation::nSpecies(), Util::Setable< T >::set(), and McMd::SystemInterface::simulation().
|
virtual |
Calculate the external energy for one Atom.
- Parameters
-
atom reference to Atom of interest
Implements McMd::ExternalPotential.
Definition at line 304 of file mcMd/potentials/external/ExternalPotentialImpl.h.
References McMd::ExternalPotentialImpl< Interaction >::interaction(), McMd::Atom::position(), and McMd::Atom::typeId().
|
inline |
Return external interaction by reference.
Definition at line 310 of file mcMd/potentials/external/ExternalPotentialImpl.h.
Referenced by McMd::ExternalPotentialImpl< Interaction >::addForces(), McMd::ExternalPotentialImpl< Interaction >::atomEnergy(), McMd::ExternalPotentialImpl< Interaction >::computeEnergy(), McMd::ExternalPotentialImpl< Interaction >::energy(), McMd::ExternalPotentialImpl< Interaction >::getForce(), McMd::McExternalPerturbation< Interaction >::interaction(), McMd::ExternalPotentialImpl< Interaction >::interactionClassName(), McMd::ExternalPotentialImpl< Interaction >::loadParameters(), McMd::ExternalPotentialImpl< Interaction >::readParameters(), McMd::McPairExternalPerturbation< PairInteraction, ExternalInteraction >::readParameters(), and McMd::ExternalPotentialImpl< Interaction >::save().
|
inline |
Return external interaction by const reference.
Definition at line 314 of file mcMd/potentials/external/ExternalPotentialImpl.h.
The documentation for this class was generated from the following file:
