Class ForwardProblem

• Defined in File forwardproblem.h

Class Documentation

class ForwardProblem

The ForwardProblem class groups all functions for solving the forward problem.

Public Functions

ForwardProblem(ExpData const *edata, gsl::not_null<Model*> model, gsl::not_null<Solver*> solver)

Constructor.

Parameters:

• edata – pointer to ExpData instance

• model – pointer to Model instance

• solver – pointer to Solver instance problem, pass nullptr for no initialization

~ForwardProblem() = default

void workForwardProblem()

Solve the forward problem.

If forward sensitivities are enabled this will also compute sensitivities.

std::vector<realtype> getAdjointUpdates(Model &model, ExpData const &edata)

Computes adjoint updates dJydx according to the provided model and ExpData.

Parameters:

• model – Model instance

• edata – experimental data

Returns:

dJydx

inline AmiVectorArray const &getStateSensitivity() const

Accessor for sx.

Returns:

sx

inline std::vector<Discontinuity> const &getDiscontinuities() const

Get information on the discontinuities encountered so far.

Returns:

The vector of discontinuities.

inline std::vector<realtype> const &getDJzdx() const

Accessor for dJzdx.

Returns:

dJzdx

inline int getCurrentTimeIteration() const

Accessor for it.

Returns:

it

inline realtype getFinalTime() const

Returns final time point for which simulations are available.

Returns:

time point

inline int getEventCounter() const

Returns maximal event index for which simulations are available.

Returns:

index

inline SimulationState const &getSimulationStateTimepoint(int const it) const

Retrieves the carbon copy of the simulation state variables at the specified timepoint index.

Parameters:

it – timepoint index

Returns:

state

inline SimulationState const &getSimulationStateEvent(int const iroot) const

Retrieves the carbon copy of the simulation state variables at the specified event index.

Parameters:

iroot – event index

Returns:

SimulationState

inline SimulationState const &getInitialSimulationState() const

Retrieves the carbon copy of the simulation state variables at the initial timepoint.

Returns:

SimulationState

inline SimulationState const &getFinalSimulationState() const

Retrieves the carbon copy of the simulation state variables at the final timepoint (or when the simulation failed)

Returns:

SimulationState

inline SteadystateProblem *getPreequilibrationProblem()

Return the preequilibration SteadystateProblem.

Returns:

The preequilibration SteadystateProblem, if any.

inline SteadystateProblem const *getPreequilibrationProblem() const

Return the preequilibration SteadystateProblem.

Returns:

The preequilibration SteadystateProblem, if any.

inline SteadystateProblem *getPostequilibrationProblem()

Return the postequilibration SteadystateProblem.

Returns:

The postequilibration SteadystateProblem, if any.

inline SteadystateProblem const *getPostequilibrationProblem() const

Return the postequilibration SteadystateProblem.

Returns:

The postequilibration SteadystateProblem, if any.

inline PeriodResult const &get_presimulation_result() const

Get the presimulation results.

Returns:

Presimulation results.

inline bool was_preequilibrated() const

Whether pre-equilibration was performed successfully.

Returns:

Public Members

Model *model

pointer to model instance

Solver *solver

pointer to solver instance

ExpData const *edata

pointer to experimental data instance