sisi4s
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Attributes | List of all members
sisi4s::ParticleHoleCoulombVertexReader Class Reference

Reads the particle-hole Coulomb vertex $\Gamma_{iG}^a$ and the occupied and virtual orbital energies $\varepsilon_i, \varepsilon_a$ from binary data file, and stores them in the CTF Tensors GammaGai, epsi, epsa. More...

#include <ParticleHoleCoulombVertexReader.hpp>

Inheritance diagram for sisi4s::ParticleHoleCoulombVertexReader:
Collaboration diagram for sisi4s::ParticleHoleCoulombVertexReader:

Classes

class  Chunk
 
class  Header
 

Public Member Functions

virtual std::string getName ()
 
 ParticleHoleCoulombVertexReader (std::vector< Argument > const &argumentList)
 
virtual ~ParticleHoleCoulombVertexReader ()
 
virtual void run ()
 Reads the Full Coulomb Vertex $\Gamma_{iG}^a$ from FTODDUMP file.
 
virtual void dryRun ()
 Performs a dry run on reading the binary Coulomb vertex file from disk. Only the header information is read containing size information.
 
- Public Member Functions inherited from sisi4s::Algorithm
 Algorithm (std::vector< Argument > const &argumentList)
 
virtual ~Algorithm ()
 
virtual std::string getName ()=0
 
virtual void run ()=0
 
virtual void dryRun ()
 The dryRun estimates resource consumption, especially memory and processor time.
 
bool isArgumentGiven (std::string const &argumentName)
 
std::string getTextArgument (std::string const &argumentName)
 
std::string getTextArgument (std::string const &argumentName, std::string const &defaultValue)
 
bool getBooleanArgument (std::string const &name)
 
bool getBooleanArgument (std::string const &name, bool const &defaultValue)
 
int64_t getIntegerArgument (std::string const &argumentName)
 
int64_t getIntegerArgument (std::string const &argumentName, int64_t const defaultValue)
 
real getRealArgument (std::string const &argumentName)
 
real getRealArgument (std::string const &argumentName, real const defaultValue)
 
template<typename F = real, typename T = Tensor<F>>
T * getTensorArgument (std::string const &argumentName)
 
template<typename F = real, typename C = std::vector<F>>
C * getContainerArgument (std::string const &argumentName)
 
template<typename F = real, typename C = std::vector<F>>
void allocateContainerArgument (std::string const &argumentName, C *container)
 
std::vector< std::string > getGivenArgumentNames () const
 
void checkArgumentsOrDie (const std::vector< std::string > args) const
 
template<typename F = real, typename T = Tensor<F>>
void allocatedTensorArgument (std::string const &argumentName, T *tensor)
 Specifies the location of an output tensor data.
 
void setRealArgument (std::string const &argumentName, real const value)
 
void setIntegerArgument (std::string const &argumentName, int const value)
 
real getRealArgumentFromInteger (IntegerData *data)
 
real getRealArgumentFromTensor (TensorData< real > *data)
 
template<typename F = real, typename T = Tensor<F>>
T * getTensorArgumentFromReal (RealData *realData)
 Converts the given real data into a scalar tensor.
 
Data * getArgumentData (std::string const &argumentName)
 

Static Public Attributes

static sisi4s::AlgorithmRegistrar< ParticleHoleCoulombVertexReader > registrar_
 

Additional Inherited Members

- Public Attributes inherited from sisi4s::Algorithm
std::string note
 
bool fallible = false
 
std::map< std::string, std::string > arguments
 

Detailed Description

Reads the particle-hole Coulomb vertex $\Gamma_{iG}^a$ and the occupied and virtual orbital energies $\varepsilon_i, \varepsilon_a$ from binary data file, and stores them in the CTF Tensors GammaGai, epsi, epsa.

Constructor & Destructor Documentation

◆ ParticleHoleCoulombVertexReader()

ParticleHoleCoulombVertexReader::ParticleHoleCoulombVertexReader ( std::vector< Argument > const &  argumentList)

◆ ~ParticleHoleCoulombVertexReader()

ParticleHoleCoulombVertexReader::~ParticleHoleCoulombVertexReader ( )
virtual

Member Function Documentation

◆ dryRun()

void ParticleHoleCoulombVertexReader::dryRun ( )
virtual

Performs a dry run on reading the binary Coulomb vertex file from disk. Only the header information is read containing size information.

Reimplemented from sisi4s::Algorithm.

Here is the call graph for this function:

◆ getName()

virtual std::string sisi4s::ParticleHoleCoulombVertexReader::getName ( )
inlinevirtual

Implements sisi4s::Algorithm.

◆ run()

void ParticleHoleCoulombVertexReader::run ( )
virtual

Reads the Full Coulomb Vertex $\Gamma_{iG}^a$ from FTODDUMP file.

Implements sisi4s::Algorithm.

Here is the call graph for this function:

Member Data Documentation

◆ registrar_

sisi4s::AlgorithmRegistrar< ParticleHoleCoulombVertexReader > ParticleHoleCoulombVertexReader::registrar_
static
The documentation for this class was generated from the following files: