Sundance::Parameter Class Reference

Inheritance diagram for Sundance::Parameter:

List of all members.

Public Member Functions
	Parameter (const double &value, const std::string &name="")
virtual	~Parameter ()
virtual XMLObject	toXML () const
virtual const double &	value () const
virtual void	setValue (const double &value)
virtual std::ostream &	toText (std::ostream &os, bool paren) const
bool	isParameter () const
Functions for internal use
Set< MultipleDeriv >	internalFindW (int order, const EvalContext &context) const
Set< MultipleDeriv >	internalFindV (int order, const EvalContext &context) const
Set< MultipleDeriv >	internalFindC (int order, const EvalContext &context) const
RCP< Array< Set< MultipleDeriv > > >	internalDetermineR (const EvalContext &context, const Array< Set< MultipleDeriv > > &RInput) const
virtual Evaluator *	createEvaluator (const EvaluatableExpr *expr, const EvalContext &context) const
virtual RCP< ExprBase >	getRcp ()
Protected Member Functions
const ParameterData *	data () const
ParameterData *	data ()

---

Detailed Description

A Parameter is an expression subtype used to represent a spatially-constant parameter that may change during the course of a simulation, for example, the time in a transient simulation or a continuation parameter when using a homotopy method. While it is possible to use simple double-precision constants in expressions, their values are immutable once created. When a constant's value may need to be changed, use a Parameter rather than a simple double.

Definition at line 60 of file SundanceParameter.hpp.

---

Constructor & Destructor Documentation

Sundance::Parameter::Parameter	(	const double &	value,
		const std::string &	name = ""
	)

virtual Sundance::Parameter::~Parameter

(

)

[inline, virtual]

virtual destructor

Definition at line 69 of file SundanceParameter.hpp.

---

Member Function Documentation

virtual Evaluator* Sundance::Parameter::createEvaluator	(	const EvaluatableExpr *	expr,
		const EvalContext &	context
	)			const [virtual]

Reimplemented from Sundance::GenericEvaluatorFactory< SpatiallyConstantExpr, ConstantEvaluator >.

ParameterData* Sundance::Parameter::data

(

)

[protected]

const ParameterData* Sundance::Parameter::data

(

)

const [protected]

virtual RCP<ExprBase> Sundance::Parameter::getRcp

(

)

[inline, virtual]

Reimplemented from Sundance::DiscreteFuncElement.

Definition at line 105 of file SundanceParameter.hpp.

RCP<Array<Set<MultipleDeriv> > > Sundance::Parameter::internalDetermineR	(	const EvalContext &	context,
		const Array< Set< MultipleDeriv > > &	RInput
	)			const [virtual]

Reimplemented from Sundance::DiscreteFuncElement.

Set<MultipleDeriv> Sundance::Parameter::internalFindC	(	int	order,
		const EvalContext &	context
	)			const [virtual]

Reimplemented from Sundance::DiscreteFuncElement.

Set<MultipleDeriv> Sundance::Parameter::internalFindV	(	int	order,
		const EvalContext &	context
	)			const [virtual]

Reimplemented from Sundance::DiscreteFuncElement.

Set<MultipleDeriv> Sundance::Parameter::internalFindW	(	int	order,
		const EvalContext &	context
	)			const [virtual]

Reimplemented from Sundance::DiscreteFuncElement.

bool Sundance::Parameter::isParameter

(

)

const [inline, virtual]

Reimplemented from Sundance::SymbolicFuncDescriptor.

Definition at line 113 of file SundanceParameter.hpp.

virtual void Sundance::Parameter::setValue

(

const double &

value

)

[virtual]

Implements Sundance::SpatiallyConstantExpr.

Referenced by Sundance::Expr::setParameterValue(), and Sundance::UnknownParameterElement::setValue().

virtual std::ostream& Sundance::Parameter::toText	(	std::ostream &	os,
		bool	paren
	)			const [inline, virtual]

Write self in text form

Reimplemented from Sundance::FuncElementBase.

Definition at line 109 of file SundanceParameter.hpp.

References Sundance::FuncElementBase::name(), and value().

virtual XMLObject Sundance::Parameter::toXML

(

)

const [virtual]

Reimplemented from Sundance::DiscreteFuncElement.

virtual const double& Sundance::Parameter::value

(

)

const [virtual]

Implements Sundance::SpatiallyConstantExpr.

Referenced by Sundance::Expr::getParameterValue(), toText(), and Sundance::UnknownParameterElement::value().