Class ForwardProblem¶
Defined in File forwardproblem.h
Class Documentation¶
-
class
amici
::
ForwardProblem
¶ The ForwardProblem class groups all functions for solving the forward problem.
Public Functions
-
ForwardProblem
(const ExpData *edata, Model *model, Solver *solver, const SteadystateProblem *preeq)¶ Constructor.
-
~ForwardProblem
() = default¶
-
void
workForwardProblem
()¶ Solve the forward problem.
If forward sensitivities are enabled this will also compute sensitivities.
-
void
getAdjointUpdates
(Model &model, const ExpData &edata)¶ computes adjoint updates dJydx according to provided model and expdata
- Parameters
model
: Model instanceedata
: experimental data
-
AmiVectorArray const &
getStateSensitivity
() const¶ Accessor for sx.
- Return
sx
-
std::vector<AmiVector> const &
getRHSAtDiscontinuities
() const¶ Accessor for xdot_disc.
- Return
xdot_disc
-
std::vector<AmiVector> const &
getRHSBeforeDiscontinuities
() const¶ Accessor for xdot_old_disc.
- Return
xdot_old_disc
-
std::vector<int> const &
getNumberOfRoots
() const¶ Accessor for nroots.
- Return
nroots
-
std::vector<std::vector<int>> const &
getRootIndexes
() const¶ Accessor for rootidx.
- Return
rootidx
-
AmiVectorArray *
getStateSensitivityPointer
()¶ accessor for pointer to sx
- Return
&sx
-
AmiVectorArray *
getStateDerivativeSensitivityPointer
()¶ Accessor for pointer to sdx.
- Return
&sdx
-
int
getCurrentTimeIteration
() const¶ Accessor for it.
- Return
it
-
realtype
getFinalTime
() const¶ Returns final time point for which simulations are available.
- Return
time point
-
int
getEventCounter
() const¶ Returns maximal event index for which simulations are available.
- Return
index
-
int
getRootCounter
() const¶ Returns maximal event index for which the timepoint is available.
- Return
index
-
const SimulationState &
getSimulationStateTimepoint
(int it) const¶ Retrieves the carbon copy of the simulation state variables at the specified timepoint index.
- Return
state
- Parameters
it
: timepoint index
-
const SimulationState &
getSimulationStateEvent
(int iroot) const¶ Retrieves the carbon copy of the simulation state variables at the specified event index.
- Return
- Parameters
iroot
: event index
-
const SimulationState &
getInitialSimulationState
() const¶ Retrieves the carbon copy of the simulation state variables at the initial timepoint.
- Return
-
const SimulationState &
getFinalSimulationState
() const¶ Retrieves the carbon copy of the simulation state variables at the final timepoint (or when simulation failed)
- Return
-