XYZEffectiveAction Struct Reference

Implementation of a flowing effective action for models with diagonal interactions.
More...

#include <XYZEffectiveAction.hpp>

Inheritance diagram for XYZEffectiveAction:

Collaboration diagram for XYZEffectiveAction:

Public Member Functions
	XYZEffectiveAction ()
	Construct a new XYZEffectiveAction object.
	XYZEffectiveAction (const float cutoff, const SpinModel &spinModel, const XYZFrgCore *core)
	Construct a new effective action and initialize values at given cutoff for a given spin model. More...
	~XYZEffectiveAction ()
	Destroy the XYZEffectiveAction object.
int	writeCheckpoint (const std::string &dataFilePath, const bool append=false) const override
	Write checkpoint file. More...
bool	readCheckpoint (const std::string &dataFilePath, const int checkpointId) override
	Read checkpoint from file. More...
bool	isDiverged () const override
	Indicate whether the vertex has diverged to NaN. More...
Public Member Functions inherited from EffectiveAction
	EffectiveAction ()
	Construct a new EffectiveAction object.
virtual	~EffectiveAction ()
	Virtual destructor.

Public Attributes
XYZVertexSingleParticle *	vertexSingleParticle
	Single-particle vertex data.
XYZVertexTwoParticle *	vertexTwoParticle
	Two-particle vertex data.
Public Attributes inherited from EffectiveAction
float	cutoff
	Value of the RG cutoff.

Detailed Description

Implementation of a flowing effective action for models with diagonal interactions.

Constructor & Destructor Documentation

XYZEffectiveAction()

XYZEffectiveAction::XYZEffectiveAction ( const float  cutoff, const SpinModel &  spinModel, const XYZFrgCore *  core  )

inline

Construct a new effective action and initialize values at given cutoff for a given spin model.

Parameters

cutoff	Cutoff value to initialize.
spinModel	Spin model to initialize.
core	Reference to the FRGCore which creates the object.

Member Function Documentation

isDiverged()

bool XYZEffectiveAction::isDiverged ( ) const

inlineoverridevirtual

Indicate whether the vertex has diverged to NaN.

Returns

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

Implements EffectiveAction.

readCheckpoint()

bool XYZEffectiveAction::readCheckpoint ( const std::string &  dataFilePath, const int  checkpointId  )

inlineoverridevirtual

Read checkpoint from file.

Parameters

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

Returns

bool Returns true if the checkpoint was read successfully, false otherwise.

Implements EffectiveAction.

writeCheckpoint()

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

inlineoverridevirtual

Write checkpoint file.

Parameters

dataFilePath	Checkpoint file path.
append	Append flag.

Returns

int Checkpoint identifier of the checkpoint written.

Implements EffectiveAction.

---

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

• /home/runner/work/SpinParser/SpinParser/src/XYZ/XYZEffectiveAction.hpp