SpinParser Class Reference

Principal object and interface for the solution of pf-FRG flow equations. More...

#include <SpinParser.hpp>

Collaboration diagram for SpinParser:

Public Member Functions
int	run (int argc, char **argv)
	Launch the SpinParser. More...
bool	isMasterRank () const
	Query wheter the current instance is the MPI master rank. More...
ComputationStatus	getComputationStatus () const
	Get the current computation status. More...
Fileset	getFileset () const
	Get file names of output files.
CommandLineOptions *	getCommandLineOptions () const
	Retrieve the internal command line parser. More...
TaskFileParser *	getTaskFileParser () const
	Retrieve the internal task file parser. More...
HMP::LoadManager *	getLoadManager () const
	Retrieve the internal load manager. More...
FrgCore *	getFrgCore () const
	Retrieve the internal numerics core. More...

Static Public Member Functions
static SpinParser *	spinParser ()
	Retrieve the SpinParser singleton. More...

Protected Member Functions
	SpinParser ()
	Construct a new SpinParser object.
	~SpinParser ()
	Destroy the SpinParser object.
void	runCore ()
	Run the numerics core and apply the differential equation solver.
void	writeCheckpoint ()
	Write current state to checkpoint file.

Protected Attributes
bool	_isMasterRank
	True, if the current instance is the MPI master rank, false otherwise.
ComputationStatus	_computationStatus
	Computation status.
Fileset	_fileset
	Output file names.
CommandLineOptions *	_commandLineOptions
	Internal command line parser.
TaskFileParser *	_taskFileParser
	Internal task file parser.
HMP::LoadManager *	_loadManager
	Internal load manager.
FrgCore *	_frgCore
	Internal numerics core.

Static Protected Attributes
static SpinParser *	_spinParserInstance = nullptr
	Singleton instance of the SpinParser.

Detailed Description

Principal object and interface for the solution of pf-FRG flow equations.

The SpinParser object provides the central interface for the solution of pf-FRG flow equations. It is designed to be a singleton, which is automatically created and retrieved via the SpinParser::spinParser() function. The solution of flow equations is then launched via the SpinParser::run() function, which is provided with the launch parameters argc and argv. Once the run() function has been triggered, the SpinParser will read in the task file, prepare the specified lattice spin model, and launch the numerics core for the solution of the respective flow equations.

Member Function Documentation

getCommandLineOptions()

CommandLineOptions * SpinParser::getCommandLineOptions

(

)

const

Retrieve the internal command line parser.

Returns

CommandLineOptions* Internal command line parser.

getComputationStatus()

ComputationStatus SpinParser::getComputationStatus

(

)

const

Get the current computation status.

Returns

ComputationStatus Computation status descriptor.

getFrgCore()

FrgCore * SpinParser::getFrgCore

(

)

const

Retrieve the internal numerics core.

Returns

FrgCore* Internal numerics core.

getLoadManager()

HMP::LoadManager * SpinParser::getLoadManager

(

)

const

Retrieve the internal load manager.

Returns

HMP::LoadManager* Internal load manager.

getTaskFileParser()

TaskFileParser * SpinParser::getTaskFileParser

(

)

const

Retrieve the internal task file parser.

Returns

TaskFileParser* Internal task file parser.

isMasterRank()

bool SpinParser::isMasterRank

(

)

const

Query wheter the current instance is the MPI master rank.

Returns

bool Returns true, if the current instance is the MPI master rank. Otherwise, returns false.

run()

int SpinParser::run	(	int	argc,
		char **	argv
	)

Launch the SpinParser.

Parameters

argc	Launch parameter argc, as provided by the operating system.
argv	Launch parameter argv, as provided by the operating system.

Returns

int Returns 0 on success, and 1 if an error occured.

spinParser()

SpinParser * SpinParser::spinParser ( )

static

Retrieve the SpinParser singleton.

Returns

SpinParser* Pointer to the singleton object.

---

The documentation for this class was generated from the following files:

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