Initial Condition (IC) Functions

Initial Condition (IC) Functions

Table 7 lists the initial condition functions, which set or return the starting time and initial conditions for the integration. Note that the final integration time is set by the last value of the SetTOut( output function.

Table 7 Initial Condition Functions.

Usage

pInteg->SetT0();

pInteg->SetT0(t0);

Arguments

Return Value

None.

Notes

The initial starting time must be consistent with the requested output times specified in SetTOut( , which must have been called first. You can use this routine to specify a start time before the first requested output time, integrating for some period before keeping track of output (such as to allow a transient to damp out). Note that you do not need to call this routine if you wish to start at the first requested TOut - t₀ is set automatically for you. Also, if you call SetTOut( again, the initial time will be reset in that routine.

Usage

pInteg->SetICs();

pInteg->SetICs(cvICs);

pInteg->SetICs(faICs, iNumICs);

Arguments

Return Value

None.

Notes

This function sets the initial conditions for the state vector. If the size of the column vector or the number of elements in the array do not match the size of the state vector, the ODE is checked for default values. If none are available, an error is returned.

Usage

t0 = pInteg->GetT0();

Arguments

None.

Return Value

Notes

None.

Usage

cvICs = pInteg->GetICs();

Arguments

None.

Return Value

Notes

This function returns the initial value of the state vector as a column vector, even if the array form was used to set the values.