GIDI::Functions::Gridded3d Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::Gridded3d:

Public Member Functions
	Gridded3d (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo)
	~Gridded3d ()
double	domainMin () const
double	domainMax () const
double	evaluate (LUPI_maybeUnused double a_x3, LUPI_maybeUnused double a_x2, LUPI_maybeUnused double a_x1) const
Array3d const &	data () const
void	modifiedMultiGroupElasticForTNSL (std::size_t maxTNSL_index)
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) const
Public Member Functions inherited from GIDI::Functions::Function3dForm
	Function3dForm (std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function3dForm (std::string const &a_moniker, FormType a_type, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function3dForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Function3dForm (Function3dForm const &a_form)
	~Function3dForm ()
virtual double	evaluate (double a_x3, double a_x2, double a_x1) const =0
Public Member Functions inherited from GIDI::Functions::FunctionForm
	FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	FunctionForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, int a_dimension, Suite *a_suite=nullptr)
	FunctionForm (FunctionForm const &a_form)
	~FunctionForm ()
FunctionForm &	operator= (FunctionForm const &a_rhs)
int	dimension () const
int	index () const
double	outerDomainValue () const
void	setOuterDomainValue (double a_outerDomainValue)
Axes const &	axes () const
Axes &	axes ()
ptwXY_interpolation	interpolation () const
void	setInterpolation (ptwXY_interpolation a_interpolation)
std::string	interpolationString () const
virtual void	toXMLList_func (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) const
Public Member Functions inherited from GIDI::Form
	Form (FormType a_type)
	Form (std::string const &a_moniker, FormType a_type, std::string const &a_label)
	Form (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Form (Form const &a_form)
virtual	~Form ()
Form &	operator= (Form const &a_rhs)
Suite *	parent () const
std::string const &	label () const
void	setLabel (std::string const &a_label)
virtual std::string	actualMoniker () const
std::string const &	keyName () const
void	setKeyName (std::string const &a_keyName)
std::string const &	keyValue () const
virtual void	setKeyValue (std::string const &a_keyName) const
FormType	type () const
Form const *	sibling (std::string a_label) const
GUPI::Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
std::string	xlinkItemKey () const
Public Member Functions inherited from GUPI::Ancestry
	Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual	~Ancestry ()
Ancestry &	operator= (Ancestry const &a_ancestry)
std::string const &	moniker () const
void	setMoniker (std::string const &a_moniker)
Ancestry *	ancestor ()
Ancestry const *	ancestor () const
void	setAncestor (Ancestry *a_ancestor)
std::string	attribute () const
Ancestry *	root ()
Ancestry const *	root () const
bool	isChild (Ancestry *a_instance)
bool	isParent (Ancestry *a_parent)
bool	isRoot () const
Ancestry *	findInAncestry (std::string const &a_href)
Ancestry const *	findInAncestry (std::string const &a_href) const
virtual Ancestry *	findInAncestry3 (std::string const &a_item)=0
virtual Ancestry const *	findInAncestry3 (std::string const &a_item) const =0
virtual LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
std::string	toXLink () const
void	printXML () const

Additional Inherited Members
Static Public Member Functions inherited from GUPI::Ancestry
static std::string	buildXLinkItemKey (std::string const &a_name, std::string const &a_key)

Detailed Description

Class for the GNDS <gridded3d> node.

Definition at line 1962 of file GIDI.hpp.

Constructor & Destructor Documentation

Gridded3d()

GIDI::Functions::Gridded3d::Gridded3d	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo )

Constructed from data in a <product> node.

Parameters

a_construction	[in] Used to pass user options to the constructor.
a_node	[in] The HAPI::Node to be parsed and used to construct the Gridded3d.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.

Definition at line 29 of file GIDI_gridded3d.cc.

                                                                                                                 :
        Function3dForm( a_construction, a_node, a_setupInfo, FormType::gridded3d ),
        m_data( a_node.child( GIDI_arrayChars ), a_setupInfo, a_construction.useSystem_strtod( ) ) {
 
}

~Gridded3d()

GIDI::Functions::Gridded3d::~Gridded3d

(

)

Definition at line 38 of file GIDI_gridded3d.cc.

                       {
 
}

Member Function Documentation

data()

Array3d const & GIDI::Functions::Gridded3d::data ( ) const

inline

Returns the value of the m_data member.

Definition at line 1975 of file GIDI.hpp.

Referenced by GIDI::Product::maximumLegendreOrder(), and GIDI::Product::multiGroupProductMatrix().

domainMax()

double GIDI::Functions::Gridded3d::domainMax ( ) const

inlinevirtual

Not properly implemented.

Implements GIDI::Functions::FunctionForm.

Definition at line 1972 of file GIDI.hpp.

domainMin()

double GIDI::Functions::Gridded3d::domainMin ( ) const

inlinevirtual

Not properly implemented.

Implements GIDI::Functions::FunctionForm.

Definition at line 1971 of file GIDI.hpp.

evaluate()

double GIDI::Functions::Gridded3d::evaluate ( LUPI_maybeUnused double a_x3, LUPI_maybeUnused double a_x2, LUPI_maybeUnused double a_x1 ) const

inline

Not properly implemented.

Definition at line 1973 of file GIDI.hpp.

modifiedMultiGroupElasticForTNSL()

void GIDI::Functions::Gridded3d::modifiedMultiGroupElasticForTNSL

(

std::size_t

maxTNSL_index

)

Only for internal use. Called by ProtareTNSL instance to zero the lower energy multi-group data covered by the ProtareSingle that contains the TNSL data covers the lower energy multi-group data.

Parameters

a_maxTNSL_index

[in] All elements up to a_maxTNSL_index exclusive are zero-ed.

Definition at line 49 of file GIDI_gridded3d.cc.

                                                                                             {
 
}

toXMLList()

void GIDI::Functions::Gridded3d::toXMLList ( GUPI::WriteInfo & a_writeInfo, std::string const & a_indent ) const

virtual

Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.

Parameters

a_writeInfo	[in/out] Instance containing incremental indentation and other information and stores the appended lines.
a_indent	[in] The amount to indent this node.

Reimplemented from GIDI::Functions::FunctionForm.

Definition at line 60 of file GIDI_gridded3d.cc.

                                                                                       {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
 
    a_writeInfo.addNodeStarter( a_indent, moniker( ) );
    axes( ).toXMLList( a_writeInfo, indent2 );
    m_data.toXMLList( a_writeInfo, indent2 );
    a_writeInfo.addNodeEnder( moniker( ) );
}

---

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

• GIDI.hpp
• GIDI_gridded3d.cc