SPARK::TUnknown Class Reference

Class used to represent the properties and the numerical values of an unknown problem variable. More...

#include <variable.h>

Inheritance diagram for SPARK::TUnknown:

[legend]Collaboration diagram for SPARK::TUnknown:

[legend]List of all members.

Public Member Functions
Structors
	TUnknown ()
	Default constructor.
	TUnknown (SPARK::TVariable *variable)
	Explicit constructor.
	TUnknown (const TUnknown &unknown)
	Copy constructor.
TUnknown &	operator= (const TUnknown &u)
Main operations (used to switch between calling contexts internally)
void	Perturb ()
	Prepares the interface for a perturbation.
void	RePerturb ()
	Prepares the interface for a re-perturbation.
void	UnPerturb ()
	Unperturb the interface after various perturbations.
Access methods
SPARK::TVariable &	operator * ()
	Dereferencing operator.
const SPARK::TVariable &	operator * () const
	Const flavor of dereferencing operator.
SPARK::TVariable *	operator-> ()
	Indirection operator.
const SPARK::TVariable *	operator-> () const
	Const flavor of indirection operator.
double	GetTarget () const
	Returns value from evaluating the matched object (used by TEquationSystem and TJacobian internally).
void	SetScale (double scalar)
	Sets the current scale to scalar.
Numerical access and arithmetic unary operators
The overloaded arithmetic operators operate on double only and are all unary operators.
	operator double () const
TUnknown &	operator= (double scalar)
TUnknown &	operator+= (double scalar)
TUnknown &	operator-= (double scalar)
TUnknown &	operator *= (double scalar)
TUnknown &	operator/= (double scalar)
Predicate methods

---

Detailed Description

Class used to represent the properties and the numerical values of an unknown problem variable.

Interface for internal manipulation of a SPARK::TVariable instance when it is an unknown. Dereference underlying SPARK::TVariable* and provides numeric interface for basic arithmetic.

---

Constructor & Destructor Documentation

SPARK::TUnknown::TUnknown (   )

Default constructor.

SPARK::TUnknown::TUnknown (  SPARK::TVariable *  variable  )  [explicit]

Explicit constructor.

SPARK::TUnknown::TUnknown (  const TUnknown &  unknown  )

Copy constructor.

---

Member Function Documentation

TUnknown& SPARK::TUnknown::operator= (  const TUnknown &  u  )

Assignment operator Warning: Use carefully. It works only if the interface has not been initialized yet. Parameters: u  Another TUnknown object used to initialize the underlying pointer of this TUnknown object Exceptions: SPARK::XInitialization  Thrown if this object has already been initialized before this call.

void SPARK::TUnknown::Perturb (   )

Prepares the interface for a perturbation.

void SPARK::TUnknown::RePerturb (   )

Prepares the interface for a re-perturbation.

void SPARK::TUnknown::UnPerturb (   )

Unperturb the interface after various perturbations.

SPARK::TVariable& SPARK::TUnknown::operator * (   )  [inline]

Dereferencing operator.

const SPARK::TVariable& SPARK::TUnknown::operator * (   )  const [inline]

Const flavor of dereferencing operator.

SPARK::TVariable* SPARK::TUnknown::operator-> (   )  [inline]

Indirection operator.

const SPARK::TVariable* SPARK::TUnknown::operator-> (   )  const [inline]

Const flavor of indirection operator.

double SPARK::TUnknown::GetTarget (   )  const

Returns value from evaluating the matched object (used by TEquationSystem and TJacobian internally). Reimplemented from SPARK::Variable::TInterface.

void SPARK::TUnknown::SetScale (  double  scalar  )

Sets the current scale to scalar.

---

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

• variable.h

---