EffectiveAction Struct Reference

Virtual implementation of a flowing effective action. More...

#include <EffectiveAction.hpp>

Inheritance diagram for EffectiveAction:

Public Member Functions
	EffectiveAction ()
	Construct a new EffectiveAction object.
virtual	~EffectiveAction ()
	Virtual destructor.
virtual int	writeCheckpoint (const std::string &dataFilePath, const bool append=false) const =0
	Write all internal data to a checkpoint at the specified file path and return the identifier of the checkpoint written. The checkpoint identifier is a non-negative integer that enumerates all the checkpoint datasets in the output file, starting at zero. More...
virtual bool	readCheckpoint (const std::string &datafilePath, const int checkpointId=-1)=0
	Read internal data from a checkpoint with the specified checkpoint identifier at the specified file path. If the checkpoint identifier is set to -1, read the most recent checkpoint. More...
virtual bool	isDiverged () const =0
	Indicate whether the vertex has diverged to NaN. More...

Public Attributes
float	cutoff
	Value of the RG cutoff.

Detailed Description

Virtual implementation of a flowing effective action.

Concrete implementations should implement datastructures as desired – e.g. two-point vertex and four-point vertex information. This object provides the virtual interface accessed by FrgCore implementations and the SpinParser.

Member Function Documentation

isDiverged()

virtual bool EffectiveAction::isDiverged ( ) const

pure virtual

Indicate whether the vertex has diverged to NaN.

Returns

bool Return true if the vertex has diverged, otherwise return false.

Implemented in XYZEffectiveAction, TRIEffectiveAction, and SU2EffectiveAction.

readCheckpoint()

virtual bool EffectiveAction::readCheckpoint ( const std::string &  datafilePath, const int  checkpointId = -1  )

pure virtual

Read internal data from a checkpoint with the specified checkpoint identifier at the specified file path. If the checkpoint identifier is set to -1, read the most recent checkpoint.

Parameters

datafilePath	Checkpoint file path.
checkpointId	Identifier of the checkpoint to read.

Returns

bool Return true if a checkpoint was read successfully; otherwise return false.

Implemented in XYZEffectiveAction, TRIEffectiveAction, and SU2EffectiveAction.

writeCheckpoint()

virtual int EffectiveAction::writeCheckpoint ( const std::string &  dataFilePath, const bool  append = false  ) const

pure virtual

Write all internal data to a checkpoint at the specified file path and return the identifier of the checkpoint written. The checkpoint identifier is a non-negative integer that enumerates all the checkpoint datasets in the output file, starting at zero.

Parameters

dataFilePath	Checkpoint file path.
append	If set to false, overwrite existing checkpoint. Otherwise, append checkpoint if no previous checkpoint at the same cutoff value exists. If a checkpoint at the same cutoff value already exists, do nothing.

Returns

int Identifier of the checkpoint written. If the writing process has been skipped, return -1.

Implemented in TRIEffectiveAction, XYZEffectiveAction, and SU2EffectiveAction.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/SpinParser/SpinParser/src/EffectiveAction.hpp