#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::Constant1d:

Public Member Functions
	Constant1d (Axes const &a_axes, double value, double a_domainMin, double a_domainMax, int a_index=0, double a_outerDomainValue=0.0)
	Constant1d (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent)
	~Constant1d ()
double	value () const
double	domainMin () const
double	domainMax () const
double	evaluate (double a_x1) const
void	mapToXsAndAdd (std::size_t a_offset, std::vector< double > const &a_Xs, std::vector< double > &a_results, double a_scaleFactor) const
XYs1d *	asXYs1d (bool a_asLinlin, double a_accuray, double a_lowerEps, double a_upperEps) const
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::Functions::Function1dForm
	Function1dForm (std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function1dForm (std::string const &a_moniker, FormType a_type, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function1dForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Function1dForm (Function1dForm const &a_form)
	~Function1dForm ()
Function1dForm &	operator= (Function1dForm const &a_rhs)
virtual void	write (FILE *a_file, std::string const &a_format) const
void	print (std::string const &a_format) const
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
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

Class for the GNDS <constant1d> node.

Definition at line 1054 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Constant1d() [1/2]

GIDI::Functions::Constant1d::Constant1d	(	Axes const &	a_axes,
		double	a_value,
		double	a_domainMin,
		double	a_domainMax,
		int	a_index = 0,
		double	a_outerDomainValue = 0.0 )

Parameters

a_axes	[in] The axes to copy for this.
a_value	[in] The GNDS value for this.
a_domainMin	[in] The minimum value for the domain.
a_domainMax	[in] The maximum value for the domain.
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 31 of file GIDI_constant1d.cc.

                                                                                                                                           :
        Function1dForm( GIDI_constant1dChars, FormType::constant1d, a_axes, ptwXY_interpolationLinLin, a_index, a_outerDomainValue ),
        m_value( a_value ),
        m_domainMin( a_domainMin ),
        m_domainMax( a_domainMax ) {
 
}

◆ Constant1d() [2/2]

GIDI::Functions::Constant1d::Constant1d	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		Suite *	a_parent )

Parameters

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

Definition at line 47 of file GIDI_constant1d.cc.

                                                                                                                                    :
        Function1dForm( a_construction, a_node, a_setupInfo, FormType::constant1d, a_parent ),
        m_value( a_node.attribute( GIDI_valueChars ).as_double( ) ),
        m_domainMin( a_node.attribute( GIDI_domainMinChars ).as_double( ) ),
        m_domainMax( a_node.attribute( GIDI_domainMaxChars ).as_double( ) ) {
 
}

◆ ~Constant1d()

GIDI::Functions::Constant1d::~Constant1d ( )

Definition at line 58 of file GIDI_constant1d.cc.

                         {
 
}

Member Function Documentation

◆ asXYs1d()

XYs1d * GIDI::Functions::Constant1d::asXYs1d	(	bool	a_asLinlin,
		double	a_accuray,
		double	a_lowerEps,
		double	a_upperEps ) const

virtual

This methods returns an XYs1d representation of this. The calling function owns the created instance and is responible for freeing it.

Parameters

a_asLinlin	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.
a_accuracy	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.
a_lowerEps	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.
a_upperEps	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.

Returns: A pointer to an XYs1d instance that must be freed by the calling function.

Reimplemented from GIDI::Functions::Function1dForm.

Definition at line 106 of file GIDI_constant1d.cc.

                                                                                                                                                                               {
 
    std::vector<double> xys( 4 );
 
    xys[0] = m_domainMin;
    xys[1] = m_value;
    xys[2] = m_domainMax;
    xys[3] = m_value;
 
    return( new XYs1d( axes( ), ptwXY_interpolationLinLin, xys ) );
}

Referenced by evaluate().

◆ domainMax()

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

inlinevirtual

Returns the value of the m_domainMax member.

Implements GIDI::Functions::FunctionForm.

Definition at line 1068 of file GIDI.hpp.

Referenced by GIDI::calculate1dMultiGroupDataInComponent().

◆ domainMin()

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

inlinevirtual

Returns the value of the m_domainMin member.

Implements GIDI::Functions::FunctionForm.

Definition at line 1067 of file GIDI.hpp.

Referenced by GIDI::calculate1dMultiGroupDataInComponent().

◆ evaluate()

double GIDI::Functions::Constant1d::evaluate ( double a_x1 ) const

virtual

Implements GIDI::Functions::Function1dForm.

◆ mapToXsAndAdd()

void GIDI::Functions::Constant1d::mapToXsAndAdd	(	std::size_t	a_offset,
		std::vector< double > const &	a_Xs,
		std::vector< double > &	a_results,
		double	a_scaleFactor ) const

virtual

Evaluates this at the X-values in a_Xs[a_offset:] and adds the results to a_results[a_offset:]. a_Xs and a_results must be the same size otherwise a throw is executed.

Parameters

a_offset	[in] The offset in a_Xs to start.
a_Xs	[in] The list of domain values to evaluate this at.
a_results	[in] The list whose values are added to by the Y-values of this.
a_scaleFactor	[in] A factor applied to each evaluation before it is added to a_results.

Reimplemented from GIDI::Functions::Function1dForm.

Definition at line 85 of file GIDI_constant1d.cc.

                                                                                                                                            {
 
    if( a_Xs.size( ) != a_results.size( ) ) throw Exception( "Constant1d::mapToXsAndAdd: a_Xs.size( ) != a_results.size( )." );
 
    for( std::size_t index = a_offset; index < a_Xs.size( ); ++index ) {
        a_results[index] += a_scaleFactor * m_value;
    }
}

Referenced by evaluate().

◆ toXMLList_func()

void GIDI::Functions::Constant1d::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 Regions1d container.

Reimplemented from GIDI::Functions::FunctionForm.

Definition at line 127 of file GIDI_constant1d.cc.

                                                                                                                                {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes;
    
    if( a_embedded ) {
        attributes += a_writeInfo.addAttribute( GIDI_outerDomainValueChars, LUPI::Misc::doubleToShortestString( outerDomainValue( ) ) ); }
    else {
        if( a_inRegions ) {
            attributes = a_writeInfo.addAttribute( GIDI_indexChars, intToString( index( ) ) ); }
        else {
            attributes = a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
        }
    }
 
    attributes += a_writeInfo.addAttribute( GIDI_valueChars, LUPI::Misc::doubleToShortestString( m_value ) );
    attributes += a_writeInfo.addAttribute( GIDI_domainMinChars, LUPI::Misc::doubleToShortestString( m_domainMin ) );
    attributes += a_writeInfo.addAttribute( GIDI_domainMaxChars, LUPI::Misc::doubleToShortestString( m_domainMax ) );
 
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
    axes( ).toXMLList( a_writeInfo, indent2 );
    a_writeInfo.addNodeEnder( moniker( ) );
}

Referenced by evaluate().

◆ value()

double GIDI::Functions::Constant1d::value ( ) const

inline

Returns the value of the m_value member.

Definition at line 1066 of file GIDI.hpp.

Referenced by GIDI::calculate1dMultiGroupDataInComponent(), and GIDI::Reaction::Reaction().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Constant1d() [1/2]

◆ Constant1d() [2/2]

◆ ~Constant1d()

Member Function Documentation

◆ asXYs1d()

◆ domainMax()

◆ domainMin()

◆ evaluate()

◆ mapToXsAndAdd()

◆ toXMLList_func()

◆ value()