Loading...
Searching...
No Matches
PLMD::gridtools::MarginalInput Class Reference

Public Member Functions

const GridCoordinatesObjectgetGridObject () const
 This gets the grid object.
 
std::vector< std::string > getMax () const
 Get the vector containing the maximum value of the grid in each dimension.
 
std::vector< std::string > getMin () const
 Get the vector containing the minimum value of the grid in each dimension.
 
std::vector< std::size_t > getNbin () const
 Get the number of grid points in each direction.
 
std::vector< bool > getPbc () const
 Get the periodicity of the grid.
 
MarginalInputoperator= (const MarginalInput &m)
 

Static Public Member Functions

static void read (MarginalInput &func, ActionWithArguments *action)
 
static void registerKeywords (Keywords &keys)
 

Public Attributes

int dir
 This is the direction we are calculating the marginal along.
 
Valuefunction =NULL
 This is the function whose marginal we are calculating.
 
ActionWithGridgridact =NULL
 This is the action that calculates the function we need.
 

Member Function Documentation

◆ getGridObject()

const GridCoordinatesObject & PLMD::gridtools::MarginalInput::getGridObject ( ) const

This gets the grid object.

◆ getMax()

std::vector< std::string > PLMD::gridtools::MarginalInput::getMax ( ) const

Get the vector containing the maximum value of the grid in each dimension.

◆ getMin()

std::vector< std::string > PLMD::gridtools::MarginalInput::getMin ( ) const

Get the vector containing the minimum value of the grid in each dimension.

◆ getNbin()

std::vector< std::size_t > PLMD::gridtools::MarginalInput::getNbin ( ) const

Get the number of grid points in each direction.

◆ getPbc()

std::vector< bool > PLMD::gridtools::MarginalInput::getPbc ( ) const

Get the periodicity of the grid.

◆ operator=()

MarginalInput & PLMD::gridtools::MarginalInput::operator= ( const MarginalInput & m)
inline

◆ read()

void PLMD::gridtools::MarginalInput::read ( MarginalInput & func,
ActionWithArguments * action )
static

◆ registerKeywords()

void PLMD::gridtools::MarginalInput::registerKeywords ( Keywords & keys)
static

Member Data Documentation

◆ dir

int PLMD::gridtools::MarginalInput::dir

This is the direction we are calculating the marginal along.

◆ function

Value* PLMD::gridtools::MarginalInput::function =NULL

This is the function whose marginal we are calculating.

◆ gridact

ActionWithGrid* PLMD::gridtools::MarginalInput::gridact =NULL

This is the action that calculates the function we need.


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