cellml_services::IDACodeGenerator Interface Reference

Inheritance diagram for cellml_services::IDACodeGenerator:

Collaboration diagram for cellml_services::IDACodeGenerator:

Public Member Functions
IDACodeInformation	generateIDACode (in cellml_api::Model sourceModel)
	Generates an IDACodeInformation object for a model.
Public Member Functions inherited from cellml_services::CodeGenerator
CodeInformation	generateCode (in cellml_api::Model sourceModel)
	Generates a CodeInformation object for a model.
CustomGenerator	createCustomGenerator (in cellml_api::Model sourceModel)
	Creates a CustomGenerator object for a model.
Public Member Functions inherited from XPCOM::IObject
void	add_ref ()
	Called to indicate that some code is keeping an owning reference to the object.
oneway void	release_ref ()
	Removes a reference to an object which was created by some other means (e.g.
IObject	query_interface (in utf8string id)
	Returns an IObject of the same implementation, which supports a specific interface.

Public Attributes
attribute wstring	residualPattern
	The pattern used when generating the residual computations for IDA.
attribute wstring	constrainedRateStateInfoPattern
	The pattern used when generating the 'state' information descriptor, for state variables where there is a constraint on the rate.
attribute wstring	unconstrainedRateStateInfoPattern
	The pattern used when generating the 'state' information descriptor, for state variables where there is no constraint on the rate.
attribute wstring	infDelayedRatePattern
	The pattern used for an 'infinitesimally delayed' rate variable (usually approximated as the value at the previous timestep).
attribute wstring	infDelayedStatePattern
	The pattern used for an 'infinitesimally delayed' state variable (usually approximated as the value at the previous timestep).
attribute boolean	trackPiecewiseConditions
	Whether or not all piecewise conditions should be refactored in terms of special variables which change sign, suitable for use with a rootfinder to restart the integrator.
attribute wstring	conditionVariablePattern
	A pattern for condition variables.
Public Attributes inherited from cellml_services::CodeGenerator
attribute wstring	constantPattern
	The pattern used to generate constant names (if they are not already annotated).
attribute wstring	stateVariableNamePattern
	The pattern used to generate state variable names (if they are not already annotated).
attribute wstring	algebraicVariableNamePattern
	The pattern used to generate algebraic variable names (if they are not already annotated).
attribute wstring	rateNamePattern
	The pattern used to generate rate names (if they are not already annotated).
attribute wstring	voiPattern
	The pattern used to generate variable of integration names (if they are not already annotated).
attribute wstring	sampleDensityFunctionPattern
	The pattern used to generate code for sampling from a density function.
attribute wstring	sampleRealisationsPattern
	The pattern used to generate code for sampling using realisations.
attribute wstring	boundVariableName
	The name to use for the locally bound variable given to the probability density function in the generated code.
attribute unsigned long	arrayOffset
	The offset at which array indices start.
attribute wstring	assignPattern
	The pattern which is used to set variables by assignment.
attribute wstring	solvePattern
	The pattern which is used to compute variables which cannot be set by assignment.
attribute wstring	solveNLSystemPattern
	The pattern which is used to solve a system of n equations in n unknowns.
attribute wstring	temporaryVariablePattern
	The pattern which is used to determine the name of temporary variables when they are required for infinitesimally expressions.
attribute wstring	declareTemporaryPattern
	The pattern used to declare that a temporary variable is in use.
attribute wstring	conditionalAssignmentPattern
	The pattern used when a top-level piecewise statement is encountered.
attribute cellml_services::MaLaESTransform	transform
	A MaLaES transform to use.
attribute cellml_services::CeVAS	useCeVAS
	The CeVAS association to use.
attribute cellml_services::CUSES	useCUSES
	The CUSES object to use.
attribute cellml_services::AnnotationSet	useAnnoSet
	The annotation set to use.
attribute boolean	allowPassthrough
	If false, any text entered shall be passed through the MaLaES sanitiser to strip out passthrough text.
Public Attributes inherited from XPCOM::IObject
readonly attribute string	objid
	Fetches the ID of the object.

Detailed Description

Definition at line 634 of file CCGS.idl.

Member Function Documentation

IDACodeInformation cellml_services::IDACodeGenerator::generateIDACode

(

in cellml_api::Model

sourceModel

)

Generates an IDACodeInformation object for a model.

Parameters

sourceModel

The model for which to generate the IDACodeInformation.

Member Data Documentation

attribute wstring cellml_services::IDACodeGenerator::conditionVariablePattern

A pattern for condition variables.

Only used if trackPiecewiseConditions is true. % is substituted for the allocated index. Default: CONDVAR[%]

Definition at line 695 of file CCGS.idl.

attribute wstring cellml_services::IDACodeGenerator::constrainedRateStateInfoPattern

The pattern used when generating the 'state' information descriptor, for state variables where there is a constraint on the rate.

<ID> is replaced by the identifier of the variable. Default: SI[<ID>] = 1.0;

Definition at line 658 of file CCGS.idl.

attribute wstring cellml_services::IDACodeGenerator::infDelayedRatePattern

The pattern used for an 'infinitesimally delayed' rate variable (usually approximated as the value at the previous timestep).

Default: RATES[%]

Definition at line 673 of file CCGS.idl.

attribute wstring cellml_services::IDACodeGenerator::infDelayedStatePattern

The pattern used for an 'infinitesimally delayed' state variable (usually approximated as the value at the previous timestep).

Default: STATES[%]

Definition at line 680 of file CCGS.idl.

attribute wstring cellml_services::IDACodeGenerator::residualPattern

The pattern used when generating the residual computations for IDA.

<RNO> is replaced with the index of the residual. <LHS> is replaced with the left-hand side of the equation. <RHS> is replaced with the right-hand side of the equation. Default: resid[<RNO>] = <LHS> - <RHS>;

Definition at line 650 of file CCGS.idl.

attribute boolean cellml_services::IDACodeGenerator::trackPiecewiseConditions

Whether or not all piecewise conditions should be refactored in terms of special variables which change sign, suitable for use with a rootfinder to restart the integrator.

Default: true

Definition at line 688 of file CCGS.idl.

attribute wstring cellml_services::IDACodeGenerator::unconstrainedRateStateInfoPattern

The pattern used when generating the 'state' information descriptor, for state variables where there is no constraint on the rate.

<ID> is replaced by the identifier of the variable. Default: SI[<ID>] = 0.0;

Definition at line 666 of file CCGS.idl.