#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::FunctionForm:

Public Member Functions
	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 double	domainMin () const =0
virtual double	domainMax () const =0
virtual void	toXMLList_func (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) 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

Base class inherited by other GIDI function classes.

Definition at line 989 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ FunctionForm() [1/4]

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 )

Parameters

a_moniker	[in] The moniker for this.
a_type	[in] The FormType the class represents.
a_dimension	[in] The dimension of the function.
a_interpolation	[in] The interpolation along the outer most independent axis and the dependent axis.
a_index	[in] Currently not used.
a_outerDomainValue	[in] If embedded in a higher dimensional function, the value of the domain of the next higher dimension.

Definition at line 202 of file GIDI_form.cc.

                                                         :
        Form( a_moniker, a_type, "" ),
        m_dimension( a_dimension ),
        m_interpolation( a_interpolation ),
        m_index( a_index ),
        m_outerDomainValue( a_outerDomainValue ) {
 
    m_interpolationString = ptwXY_interpolationToString( m_interpolation );
}

◆ FunctionForm() [2/4]

GIDI::Functions::FunctionForm::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 )

Parameters

a_moniker	[in] The moniker for this.
a_type	[in] The FormType the class represents.
a_dimension	[in] The dimension of the function.
a_axes	[in] The axes for the function.
a_interpolation	[in] The interpolation along the outer most independent axis and the dependent axis.
a_index	[in] Currently not used.
a_outerDomainValue	[in] If embedded in a higher dimensional function, the value of the domain of the next higher dimension.

Definition at line 223 of file GIDI_form.cc.

                                                         :
        Form( a_type ),
        m_dimension( a_dimension ), 
        m_axes( a_axes ),
        m_interpolation( a_interpolation ),
        m_index( a_index ),
        m_outerDomainValue( a_outerDomainValue ) {
 
    setMoniker( a_moniker );
    m_interpolationString = ptwXY_interpolationToString( m_interpolation );
 
    m_axes.setAncestor( this );
}

◆ FunctionForm() [3/4]

GIDI::Functions::FunctionForm::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() [4/4]

GIDI::Functions::FunctionForm::FunctionForm ( FunctionForm const & a_form )

Parameters

a_form [in] The FunctionForm to copy.

Definition at line 268 of file GIDI_form.cc.

                                                       :
        Form( a_form ),
        m_dimension( a_form.dimension( ) ),
        m_axes( a_form.axes( ) ),
        m_interpolation( a_form.interpolation( ) ),
        m_interpolationString( a_form.interpolationString( ) ),
        m_index( a_form.index( ) ),
        m_outerDomainValue( a_form.outerDomainValue( ) ) {
 
}

◆ ~FunctionForm()

GIDI::Functions::FunctionForm::~FunctionForm ( )

Definition at line 282 of file GIDI_form.cc.

                             {
 
}

Member Function Documentation

◆ axes() [1/2]

Axes & GIDI::Functions::FunctionForm::axes ( )

inline

Returns a reference to the m_axes member.

Definition at line 1013 of file GIDI.hpp.

◆ axes() [2/2]

Axes const & GIDI::Functions::FunctionForm::axes ( ) const

inline

Returns a const reference to the m_axes member.

Definition at line 1012 of file GIDI.hpp.

◆ dimension()

int GIDI::Functions::FunctionForm::dimension ( ) const

inline

Returns the value of the m_dimension member.

Definition at line 1007 of file GIDI.hpp.

Referenced by GIDI::Functions::Regions1d::append(), GIDI::Functions::Regions2d::append(), FunctionForm(), and operator=().

◆ domainMax()

virtual double GIDI::Functions::FunctionForm::domainMax ( ) const

pure virtual

Referenced by GIDI::Functions::Regions1d::append(), and GIDI::Functions::Regions2d::append().

◆ domainMin()

virtual double GIDI::Functions::FunctionForm::domainMin ( ) const

pure virtual

Referenced by GIDI::Functions::Regions1d::append(), and GIDI::Functions::Regions2d::append().

◆ index()

int GIDI::Functions::FunctionForm::index ( ) const

inline

Returns the value of the m_index member.

Definition at line 1009 of file GIDI.hpp.

◆ interpolation()

ptwXY_interpolation GIDI::Functions::FunctionForm::interpolation ( ) const

inline

Returns the value of the m_interpolation member.

Definition at line 1015 of file GIDI.hpp.

Referenced by FunctionForm(), GIDI::Reaction::modifyCrossSection(), operator=(), GIDI::Functions::Xs_pdf_cdf1d::toXMLList_func(), GIDI::Functions::XYs1d::toXMLList_func(), GIDI::Functions::XYs1d::XYs1d(), and GIDI::Functions::XYs1d::XYs1d().

◆ interpolationString()

std::string GIDI::Functions::FunctionForm::interpolationString ( ) const

inline

Returns the value of the m_interpolationString member.

Definition at line 1017 of file GIDI.hpp.

Referenced by FunctionForm(), operator=(), GIDI::Functions::Xs_pdf_cdf1d::toXMLList_func(), GIDI::Functions::XYs1d::toXMLList_func(), and GIDI::Functions::XYs1d::XYs1d().

◆ operator=()

FunctionForm & GIDI::Functions::FunctionForm::operator= ( FunctionForm const & a_rhs )

The assignment operator. This method sets the members of this to those of a_rhs except for those not set by base classes.

Parameters

a_rhs [in] Instance whose member are used to set the members of this.

Definition at line 293 of file GIDI_form.cc.

                                                               {
 
    if( this != &a_rhs ) {
        Form::operator=( a_rhs );
 
        m_dimension = a_rhs.dimension( );
        m_axes = a_rhs.axes( );
        m_interpolation = a_rhs.interpolation( );
        m_interpolationString = a_rhs.interpolationString( );
        m_index = a_rhs.index( );
        m_outerDomainValue = a_rhs.outerDomainValue( );
    }
 
    return( *this );
}

Referenced by GIDI::Functions::Function1dForm::operator=().

◆ outerDomainValue()

double GIDI::Functions::FunctionForm::outerDomainValue ( ) const

inline

Returns the value of the m_outerDomainValue member.

Definition at line 1010 of file GIDI.hpp.

◆ setInterpolation()

void GIDI::Functions::FunctionForm::setInterpolation ( ptwXY_interpolation a_interpolation )

This method sets the integer (i.e., ptwXY_interpolation) interpolation value of m_interpolation to a_interpolation. This method also sets the m_interpolationString member per a_interpolation.

Parameters

a_interpolation [in] The ptwXY_interpolation integer value of the interpolaction.

Definition at line 316 of file GIDI_form.cc.

                                                                         {
 
    m_interpolation = a_interpolation;
    m_interpolationString = ptwXY_interpolationToString( m_interpolation );
} 

◆ setOuterDomainValue()

void GIDI::Functions::FunctionForm::setOuterDomainValue ( double a_outerDomainValue )

inline

Definition at line 1011 of file GIDI.hpp.

1011{ m_outerDomainValue = a_outerDomainValue; }

◆ toXMLList()

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

inlinevirtual

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 GUPI::Ancestry.

Reimplemented in GIDI::Functions::Gridded2d, GIDI::Functions::Gridded3d, and GIDI::Functions::Reference1d.

Definition at line 1023 of file GIDI.hpp.

1023{ toXMLList_func( a_writeInfo, a_indent, false, false ); }

GIDI::Functions::FunctionForm::toXMLList_func

virtual void toXMLList_func(GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) const

Definition GIDI_form.cc:331

Referenced by GIDI::energy2dToXMLList().

◆ toXMLList_func()

void GIDI::Functions::FunctionForm::toXMLList_func	(	GUPI::WriteInfo &	a_writeInfo,
		std::string const &	a_indent,
		bool	a_embedded,
		bool	a_inRegions ) 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.
a_embedded	[in] If true, this function is embedded in a higher dimensional function.
a_inRegions	[in] If true, this is in a Regions container.

Definition at line 331 of file GIDI_form.cc.

                                                                                                                                                                                                      {
 
    std::cout << "Node '" << moniker( ) << "' needs toXMLList methods." << std::endl;
}

Referenced by domainMax(), and toXMLList().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FunctionForm() [1/4]

◆ FunctionForm() [2/4]

◆ FunctionForm() [3/4]

◆ FunctionForm() [4/4]

◆ ~FunctionForm()

Member Function Documentation

◆ axes() [1/2]

◆ axes() [2/2]

◆ dimension()

◆ domainMax()

◆ domainMin()

◆ index()

◆ interpolation()

◆ interpolationString()

◆ operator=()

◆ outerDomainValue()

◆ setInterpolation()

◆ setOuterDomainValue()

◆ toXMLList()

◆ toXMLList_func()