apfel::Grid Class Reference

The Grid class defines ab object that is essentially a collection of "SubGrid" objects plus other global parameters. This class also includes all the relevant methods for the manipulation of the SubGrids. More...

#include <grid.h>

Public Member Functions
	Grid (std::vector< SubGrid > const &grs)
	The Grid constructor.
Getters
int	nGrids () const
std::vector< std::pair< int, int > > const &	SubToJointMap () const
std::vector< std::vector< int > > const &	JointToSubMap () const
std::vector< int > const &	TransitionPoints () const
std::vector< SubGrid > const &	GetSubGrids () const
SubGrid const &	GetSubGrid (int ig) const
SubGrid const &	GetJointGrid () const
void	Print () const
	Print the Grid object.
Comparison operators
Collection of operators for comparing grid objects
bool	operator== (Grid const &g) const
bool	operator!= (Grid const &g) const

Private Member Functions
SubGrid	CreateJointGrid ()
	Fill in the joint grid object with the appropriate grid nodes.

Private Attributes
std::vector< std::pair< int, int > >	_SubToJointMap
	Vector of pairs corresponding to grid- and node-indices on the subgrids.
std::vector< std::vector< int > >	_JointToSubMap
	Vector of indices from the subgrids to the joint grid.
std::vector< int >	_TransPoints
	Vector of indices corresponding to the transition from one subgrid to the other.
std::vector< SubGrid >	_GlobalGrid
	Vector with sub-grids.
std::unique_ptr< SubGrid >	_JointGrid
	Container for the joint grid.

Friends
std::ostream &	operator<< (std::ostream &os, Grid const &gr)
	Overload the << operator to print the parameters of the grid.

Detailed Description

The Grid class defines ab object that is essentially a collection of "SubGrid" objects plus other global parameters. This class also includes all the relevant methods for the manipulation of the SubGrids.

Examples

dglap_test.cc, dglap_test_streamlined.cc, distribution_test.cc, doubleobjint_test.cc, gpd_test.cc, grid_test.cc, interpolation_test.cc, massiveCF_test.cc, operator_test.cc, principal_value_test.cc, qgriddist_test.cc, set_test.cc, structurefunction_cc_test.cc, structurefunction_massive_test.cc, structurefunction_nc_pol_test.cc, structurefunction_nc_test.cc, and tmd_test.cc.

Constructor & Destructor Documentation

Grid()

apfel::Grid::Grid

(

std::vector< SubGrid > const &

grs

)

The Grid constructor.

Parameters

grs	vector of subgrids

Member Function Documentation

CreateJointGrid()

SubGrid apfel::Grid::CreateJointGrid ( )

private

Fill in the joint grid object with the appropriate grid nodes.

Returns

the joint grid

GetJointGrid()

SubGrid const & apfel::Grid::GetJointGrid ( ) const

inline

Returns

The joint SubGrid

GetSubGrid()

SubGrid const & apfel::Grid::GetSubGrid ( int ig ) const

inline

Returns

The ig-th SubGrid

GetSubGrids()

std::vector< SubGrid > const & apfel::Grid::GetSubGrids ( ) const

inline

Returns

The vector of subgrids

JointToSubMap()

std::vector< std::vector< int > > const & apfel::Grid::JointToSubMap ( ) const

inline

Returns

The map of indices from the subgrids to the joint grid

nGrids()

int apfel::Grid::nGrids ( ) const

inline

Returns

The number of subgrids

operator!=()

bool apfel::Grid::operator!=

(

Grid const &

g

)

const

operator==()

bool apfel::Grid::operator==

(

Grid const &

g

)

const

Print()

void apfel::Grid::Print ( ) const

inline

Print the Grid object.

SubToJointMap()

std::vector< std::pair< int, int > > const & apfel::Grid::SubToJointMap ( ) const

inline

Returns

The map of indices from the joint grid to the subgrids

TransitionPoints()

std::vector< int > const & apfel::Grid::TransitionPoints ( ) const

inline

Returns

The vector of transition indices on the joint grid

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, Grid const & gr )

friend

Overload the << operator to print the parameters of the grid.

Member Data Documentation

_GlobalGrid

std::vector<SubGrid> apfel::Grid::_GlobalGrid

private

Vector with sub-grids.

_JointGrid

std::unique_ptr<SubGrid> apfel::Grid::_JointGrid

private

Container for the joint grid.

_JointToSubMap

std::vector<std::vector<int> > apfel::Grid::_JointToSubMap

private

Vector of indices from the subgrids to the joint grid.

_SubToJointMap

std::vector<std::pair<int, int> > apfel::Grid::_SubToJointMap

private

Vector of pairs corresponding to grid- and node-indices on the subgrids.

_TransPoints

std::vector<int> apfel::Grid::_TransPoints

private

Vector of indices corresponding to the transition from one subgrid to the other.

---

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

• /Users/vb262523/Codes/apfelxx/inc/apfel/grid.h