CFindDimensions Class Reference

#include <CDimension.h>

List of all members.

Public Member Functions
	CFindDimensions (const CFunction *function, bool d1, bool d2, bool d3, bool d4, bool d5)
void	setupDimensions ()
void	findDimensions (CDimension rootDim)
void	findDimensions (bool isMulticompartment)
std::vector< std::string >	findDimensionsBoth (const CCopasiDataModel *pDataModel)
const std::vector< CDimension > &	getDimensions () const
void	setUseHeuristics (bool flag)
void	setChemicalEquation (const CChemEq *eq)
void	setMolecularitiesForMassAction (const unsigned C_INT32 &m1, const unsigned C_INT32 &m2)

---

Detailed Description

CFindDimensions class. The class tries to find the dimensions of the "PARAMETER" variable nodes in a function tree.

The function is specified in the constructor. After that the dimension of the root node has to be specified. This can be done with either of the two public findDimensions() methods. The result can be retrieved using the getDimensions() method.

---

Constructor & Destructor Documentation

CFindDimensions::CFindDimensions	(	const CFunction *	function,
		bool	d1,
		bool	d2,
		bool	d3,
		bool	d4,
		bool	d5
	)

construct the class for a given function. d1,d2,d3, d4, d5 indicate if the base unit (for quantity, volume, time, area, length) is dimensionless

---

Member Function Documentation

void CFindDimensions::findDimensions

(

CDimension

rootDim

)

find the dimensions from explicitly given root node dimension

void CFindDimensions::findDimensions

(

bool

isMulticompartment

)

find the dimensions for a function that is used in a reaction the dimension of the root node depends on the number of compartments that are involved in the reaction

std::vector< std::string > CFindDimensions::findDimensionsBoth

(

const CCopasiDataModel *

pDataModel

)

find the dimensions for both a one-compartment and a multi-compartment reaction

const std::vector< CDimension > & CFindDimensions::getDimensions

(

)

const

void CFindDimensions::setChemicalEquation

(

const CChemEq *

eq

)

tell about chemical equation. This is needed only for mass action kinetics. It is ignored otherwise.

void CFindDimensions::setMolecularitiesForMassAction	(	const unsigned C_INT32 &	m1,
		const unsigned C_INT32 &	m2
	)

void CFindDimensions::setupDimensions

(

)

initialize the known dimensions (from the parameter roles) and set the others to "unknown". This is called by the constructor.

void CFindDimensions::setUseHeuristics

(

bool

flag

)

---

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

• copasi/utilities/CDimension.h
• copasi/utilities/CDimension.cpp