|
Simpatico
v1.10
|
Template for a value that can be set or declared null (i.e., unknown).
Type T must be copy-constructable and have an assignment (=) operator.
Convention for MPI programs: In parallel MPI programs in which a value for a variable is calculated by a reduce operation and is set only on a master processor, a default value should be set on all other processors whenever the true value is set on the master. This indicates on all processors that the value is known, though it may only be available on the master processor. Similarly, when a value is unset, the unset() function should be called on all processors. This convention allows the isSet() function to be used on all processors to query whether the value is known, which may be then be used to decide when to initiate a recomputation that may require computation on all processors. This convention is imposed by the isValid() function, which requires that isSet have the same value on all processors within a communicator (i.e., all true or all false).
#include <Setable.h>
Public Member Functions | |
| Setable () | |
| Default constructor. More... | |
| Setable (const Setable< T > &other) | |
| Copy constructor. More... | |
| Setable (const T &value) | |
| Construct from T value (explicit). More... | |
| Setable< T > & | operator= (const Setable< T > &other) |
| Assignment from another Setable<T> object. More... | |
| Setable< T > & | operator= (const T &value) |
| Assignment from T value. More... | |
| void | set (const T &value) |
| Set the value and mark as set. More... | |
| void | unset () |
| Unset the value (mark as unknown). More... | |
| bool | isSet () const |
| Is this object set (is the value known)? More... | |
| const T & | value () const |
| Return value (if set). More... | |
| bool | isValid (MPI::Intracomm &communicator) const |
| Test consistency of states on different processors. More... | |
|
inline |
|
inline |
|
inlineexplicit |
|
inline |
|
inline |
|
inline |
Set the value and mark as set.
| value | value to be assigned. |
Definition at line 107 of file Setable.h.
Referenced by McMd::SpecialPotentialFacade< PotentialType, FactoryType >::computeEnergy(), McMd::ExternalPotentialImpl< Interaction >::computeEnergy(), McMd::MdSpmePotential::computeEnergy(), McMd::MdEwaldPotential::computeEnergy(), McMd::LinkPotentialImpl< Interaction >::computeEnergy(), McMd::BondPotentialImpl< Interaction >::computeEnergy(), McMd::McPairPotentialImpl< Interaction >::computeEnergy(), McMd::MdEwaldPairPotentialImpl< Interaction >::computeEnergy(), McMd::MdPairPotentialImpl< Interaction >::computeEnergy(), McMd::DihedralPotentialImpl< Interaction >::computeEnergy(), McMd::AnglePotentialImpl< Interaction >::computeEnergy(), DdMd::AtomStorage::computeNAtomTotal(), DdMd::GroupStorage< N >::computeNTotal(), DdMd::PairList::computeStatistics(), DdMd::GroupStorage< N >::computeStatistics(), DdMd::Buffer::computeStatistics(), DdMd::AtomStorage::computeStatistics(), DdMd::GroupStorage< N >::loadParameters(), and DdMd::Potential::setEnergy().
|
inline |
Unset the value (mark as unknown).
Definition at line 116 of file Setable.h.
Referenced by DdMd::PairList::clearStatistics(), DdMd::GroupStorage< N >::clearStatistics(), DdMd::Buffer::clearStatistics(), DdMd::AtomStorage::clearStatistics(), DdMd::Potential::unsetEnergy(), McMd::MdCoulombPotential::unsetEnergy(), McMd::MdEwaldPairPotentialImpl< Interaction >::unsetEnergy(), DdMd::AtomStorage::unsetNAtomTotal(), and DdMd::GroupStorage< N >::unsetNTotal().
|
inline |
Is this object set (is the value known)?
Definition at line 124 of file Setable.h.
Referenced by McMd::SpecialPotentialFacade< PotentialType, FactoryType >::computeEnergy(), DdMd::GroupStorage< N >::computeNTotal(), DdMd::Potential::isEnergySet(), Util::Setable< T >::isValid(), DdMd::GroupStorage< N >::isValid(), and McMd::MdCoulombPotential::kSpaceEnergy().
|
inline |
Return value (if set).
Throws an Exception if value is not set.
Definition at line 132 of file Setable.h.
Referenced by DdMd::Potential::energy(), McMd::MdCoulombPotential::kSpaceEnergy(), Util::Setable< Util::Tensor >::operator=(), DdMd::PairList::outputStatistics(), DdMd::GroupStorage< N >::outputStatistics(), DdMd::Buffer::outputStatistics(), DdMd::AtomStorage::outputStatistics(), DdMd::GroupStorage< N >::save(), and Util::Setable< Util::Tensor >::set().
| bool Util::Setable< T >::isValid | ( | MPI::Intracomm & | communicator | ) | const |
Test consistency of states on different processors.
If valid, return true, else throws an Exception. The state is valid if the value of isSet is the same on all processors.
Definition at line 163 of file Setable.h.
References Util::Setable< T >::isSet(), and UTIL_THROW.
Referenced by DdMd::Potential::isValid(), DdMd::AtomStorage::isValid(), and Util::Setable< Util::Tensor >::value().
1.8.11