#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::Function2dForm:

Public Member Functions
	Function2dForm (std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function2dForm (std::string const &a_moniker, FormType a_type, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function2dForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Function2dForm (Function2dForm const &a_form)
	~Function2dForm ()
virtual double	evaluate (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 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

Definition at line 1522 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Function2dForm() [1/4]

GIDI::Functions::Function2dForm::Function2dForm	(	std::string const &	a_moniker,
		FormType	a_type,
		ptwXY_interpolation	a_interpolation,
		int	a_index,
		double	a_outerDomainValue )

Parameters

a_moniker	[in] The GNDS node name for the 2d function.
a_type	[in] The FormType the class represents.
a_interpolation	[in] The interpolation along the outer most independent axis and the dependent axis.
a_index	[in] The GNDS index value for this.
a_outerDomainValue	[in] The GNDS outerDomainValue value for this.

Definition at line 476 of file GIDI_form.cc.

                                                                                                                                                         :
        FunctionForm( a_moniker, a_type, 2, a_interpolation, a_index, a_outerDomainValue ) {
 
}

◆ Function2dForm() [2/4]

GIDI::Functions::Function2dForm::Function2dForm	(	std::string const &	a_moniker,
		FormType	a_type,
		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_axes	[in] The axes to copy for this.
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 490 of file GIDI_form.cc.

                                                         :
        FunctionForm( a_moniker, a_type, 2, a_axes, a_interpolation, a_index, a_outerDomainValue ) {
 
}

◆ Function2dForm() [3/4]

GIDI::Functions::Function2dForm::Function2dForm	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		FormType	a_type,
		Suite *	a_suite = nullptr )

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 FunctionForm.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_type	[in] The FormType the class represents.
a_suite	[in] The parent GIDI::Suite.

Definition at line 504 of file GIDI_form.cc.

                                          :
        FunctionForm( a_construction, a_node, a_setupInfo, a_type, 2, a_suite ) {
 
}

◆ Function2dForm() [4/4]

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

Parameters

a_form [in] Function2dForm to copy.

Definition at line 513 of file GIDI_form.cc.

                                                             :
        FunctionForm( a_form ) {
        
}

◆ ~Function2dForm()

GIDI::Functions::Function2dForm::~Function2dForm ( )

Definition at line 521 of file GIDI_form.cc.

                                 {
 
}

Member Function Documentation

◆ evaluate()

virtual double GIDI::Functions::Function2dForm::evaluate	(	double	a_x2,
		double	a_x1 ) const

pure virtual

Implemented in GIDI::Functions::DiscreteGamma2d, GIDI::Functions::Evaporation2d, GIDI::Functions::GeneralEvaporation2d, GIDI::Functions::Isotropic2d, GIDI::Functions::MadlandNix2d, GIDI::Functions::NBodyPhaseSpace2d, GIDI::Functions::PrimaryGamma2d, GIDI::Functions::Recoil2d, GIDI::Functions::Regions2d, GIDI::Functions::SimpleMaxwellianFission2d, GIDI::Functions::Watt2d, GIDI::Functions::Weighted_function2d, GIDI::Functions::WeightedFunctionals2d, and GIDI::Functions::XYs2d.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Function2dForm() [1/4]

◆ Function2dForm() [2/4]

◆ Function2dForm() [3/4]

◆ Function2dForm() [4/4]

◆ ~Function2dForm()

Member Function Documentation

◆ evaluate()