SpinParser  1.0
Public Member Functions | Public Attributes | List of all members
TRIEffectiveAction Struct Reference

Implementation of a flowing effective action for time reversal invariant models.
More...

#include <TRIEffectiveAction.hpp>

Inheritance diagram for TRIEffectiveAction:
Inheritance graph
[legend]
Collaboration diagram for TRIEffectiveAction:
Collaboration graph
[legend]

Public Member Functions

 TRIEffectiveAction ()
 Construct a new TRIEffectiveAction object.
 
 TRIEffectiveAction (const float cutoff, const SpinModel &spinModel, const TRIFrgCore *core)
 Construct a new effective action and initialize values at given cutoff for a given spin model. More...
 
 ~TRIEffectiveAction ()
 Destroy the TRIEffectiveAction 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

TRIVertexSingleParticlevertexSingleParticle
 Single-particle vertex data.
 
TRIVertexTwoParticlevertexTwoParticle
 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 time reversal invariant models.

Constructor & Destructor Documentation

◆ TRIEffectiveAction()

TRIEffectiveAction::TRIEffectiveAction ( const float  cutoff,
const SpinModel spinModel,
const TRIFrgCore core 
)
inline

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

Parameters
cutoffCutoff value to initialize.
spinModelSpin model to initialize.
coreReference to the FRGCore which creates the object.

Member Function Documentation

◆ isDiverged()

bool TRIEffectiveAction::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 TRIEffectiveAction::readCheckpoint ( const std::string &  dataFilePath,
const int  checkpointId 
)
inlineoverridevirtual

Read checkpoint from file.

Parameters
dataFilePathCheckpoint file path.
checkpointIdIdentifier of the checkpoint to read.
Returns
bool Returns true if the checkpoint was read successfully, false otherwise.

Implements EffectiveAction.

◆ writeCheckpoint()

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

Write checkpoint file.

Parameters
dataFilePathCheckpoint file path.
appendAppend flag.
Returns
int Checkpoint identifier of the checkpoint written.

Implements EffectiveAction.


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