Virtual implementation of a measurement protocol. More...
#include <Measurement.hpp>
Public Member Functions | |
| Measurement (const std::string &outfile, const float minCutoff, const float maxCutoff, const bool isDeferred) | |
| Construct a non load managed Measurement object. More... | |
| virtual | ~Measurement () |
| Virtual destructor. | |
| virtual void | takeMeasurement (const EffectiveAction &state, const bool isMasterTask) const =0 |
| Virtual implementation of the measurement routine. This routine is called from the SpinParser whenever a measurement should be performed. Measurement sould be performed on the specified effective action. More... | |
| std::string | outfile () const |
| Return the filename of the output file. More... | |
| float | minCutoff () const |
| Return the minimum cutoff above which the measurement protocol is invoked. More... | |
| float | maxCutoff () const |
| Return the maximum cutoff value below which the measurement protocol is invoked. More... | |
| bool | isDeferred () const |
| Query whether the measurement protocol is a deferred measurement. More... | |
| bool | isLoadManaged () const |
| Query whether the measurement protocol is load managed. More... | |
| std::vector< HMP::StackIdentifier > | getLoadManagedStacks () const |
| Return a list of LoadManager::DataStack ids to compute in the FrgCore::computeStep() function. More... | |
Protected Member Functions | |
| Measurement (const std::string &outfile, const float minCutoff, const float maxCutoff, const bool isDeferred, const bool isLoadManaged) | |
| Construct a new Measurement object. More... | |
Protected Attributes | |
| bool | _isLoadManaged |
| If set to true, the measurement protocol is considered to be load managed. Derived classes should initialize this variable with the desired value in the constructor. | |
| std::vector< HMP::StackIdentifier > | _loadManagedStacks |
| Contains a list of load managed stack identifiers. Derived classis should initialize this list in the constructor. | |
Detailed Description
Virtual implementation of a measurement protocol.
Measurement protocols are part of the FrgCore. Concrete implementations of the protocol may take specific measurements. A measurement may potentially have two special properties; It can be a deferred measurement, and it can be a load managed measurement.
A deferred measurement will not compute any measurements during the solution of the flow equations. Instead, the measurements are copmuted in the Postprocessing phase, which is entered by re-running the SpinParser with the same task file that includes deferred measurements. In order to enable postprocessing measurements, during the solution of the flow equations, the vertex data itself is written to the disk. The deferred property can be chosen at initialization time of the measurement.
A load managed measurement does not necessarily run all computations on its own. Instead, it can provide a list of LoadManager::DataStack ids, which are then calculated in the FrgCore::computeStep() phase. This allows the FrgCore to perform better load balancing between the different flow equations and the calculations required for the measurements. The load managed propery is inherent to the measurement. Derived measurement classes should initialize the member variable Meausrement::_isLoadManaged with the desired value.
Constructor & Destructor Documentation
◆ Measurement() [1/2]
| Measurement::Measurement | ( | const std::string & | outfile, |
| const float | minCutoff, | ||
| const float | maxCutoff, | ||
| const bool | isDeferred | ||
| ) |
Construct a non load managed Measurement object.
- Parameters
-
outfile Filename where to write the result file. minCutoff Minimum cutoff above which to invoke the measurement protocol. maxCutoff Maximum cutoff below which to invoke the measurement protocol. isDeferred If set to true, measurements are deferred to the postprocessing stage.
◆ Measurement() [2/2]
|
protected |
Construct a new Measurement object.
- Parameters
-
outfile Filename where to write the result file. minCutoff Minimum cutoff above which to invoke the measurement protocol. maxCutoff Maximum cutoff below which to invoke the measurement protocol. isDeferred If set to true, measurements are deferred to the postprocessing stage. isLoadManaged If set to true, measurement is assumed to be load managed.
Member Function Documentation
◆ getLoadManagedStacks()
| std::vector< int > Measurement::getLoadManagedStacks | ( | ) | const |
Return a list of LoadManager::DataStack ids to compute in the FrgCore::computeStep() function.
- See also
- Measurement::isLoadManaged()
- Returns
- std::vector<int> List of DataStack ids.
◆ isDeferred()
| bool Measurement::isDeferred | ( | ) | const |
Query whether the measurement protocol is a deferred measurement.
- Returns
- bool Return true, if the measurement is a deferred measurement. Return false otherwise.
◆ isLoadManaged()
| bool Measurement::isLoadManaged | ( | ) | const |
Query whether the measurement protocol is load managed.
A measurement protocol which is load managed provides a list of LoadManager::DataStack ids in the Measurement::getLoadManagedStacks() routine. Those stacks should then be calculated in the FrgCore::computeStep() function; This mechanism allows for better load balancing.
- Returns
- bool Return true, if the measurement is load managed. Return false otherwise.
◆ maxCutoff()
| float Measurement::maxCutoff | ( | ) | const |
Return the maximum cutoff value below which the measurement protocol is invoked.
- Returns
- float Maximum cutoff value.
◆ minCutoff()
| float Measurement::minCutoff | ( | ) | const |
Return the minimum cutoff above which the measurement protocol is invoked.
- Returns
- float Minimum cutoff value.
◆ outfile()
| std::string Measurement::outfile | ( | ) | const |
Return the filename of the output file.
- Returns
- std::string Output filename.
◆ takeMeasurement()
|
pure virtual |
Virtual implementation of the measurement routine. This routine is called from the SpinParser whenever a measurement should be performed. Measurement sould be performed on the specified effective action.
- Parameters
-
state Effective action object to perform the measurement on. isMasterTask If set to true, the function call should be responsible for writing the output file.
Implemented in SU2MeasurementCorrelation, TRIMeasurementCorrelation, and XYZMeasurementCorrelation.
The documentation for this class was generated from the following files:
- /home/runner/work/SpinParser/SpinParser/src/Measurement.hpp
- /home/runner/work/SpinParser/SpinParser/src/Measurement.cpp
