Chaste
Release::2018.1
|
#include <BackwardEulerIvpOdeSolver.hpp>
Public Member Functions | |
BackwardEulerIvpOdeSolver (unsigned sizeOfOdeSystem) | |
~BackwardEulerIvpOdeSolver () | |
void | SetEpsilonForNumericalJacobian (double epsilon) |
void | ForceUseOfNumericalJacobian () |
unsigned | GetSystemSize () const |
Public Member Functions inherited from AbstractOneStepIvpOdeSolver | |
virtual OdeSolution | Solve (AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rYValues, double startTime, double endTime, double timeStep, double timeSampling) |
virtual void | Solve (AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rYValues, double startTime, double endTime, double timeStep) |
virtual | ~AbstractOneStepIvpOdeSolver () |
Public Member Functions inherited from AbstractIvpOdeSolver | |
virtual void | SolveAndUpdateStateVariable (AbstractOdeSystem *pAbstractOdeSystem, double startTime, double endTime, double timeStep) |
bool | StoppingEventOccurred () |
double | GetStoppingTime () |
AbstractIvpOdeSolver () | |
virtual | ~AbstractIvpOdeSolver () |
Public Member Functions inherited from Identifiable | |
virtual | ~Identifiable () |
std::string | GetIdentifier () const |
Protected Member Functions | |
void | CalculateNextYValue (AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rNextYValues) |
Protected Member Functions inherited from AbstractOneStepIvpOdeSolver | |
virtual void | InternalSolve (AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rCurrentYValues, std::vector< double > &rWorkingMemory, double startTime, double endTime, double timeStep) |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &archive, const unsigned int version) |
void | ComputeResidual (AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rCurrentGuess) |
void | ComputeJacobian (AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rCurrentGuess) |
void | SolveLinearSystem () |
double | ComputeNorm (double *pVector) |
void | ComputeNumericalJacobian (AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rCurrentGuess) |
Private Attributes | |
unsigned | mSizeOfOdeSystem |
double | mNumericalJacobianEpsilon |
bool | mForceUseOfNumericalJacobian |
double * | mResidual |
double ** | mJacobian |
double * | mUpdate |
Friends | |
class | boost::serialization::access |
Additional Inherited Members | |
Protected Attributes inherited from AbstractIvpOdeSolver | |
bool | mStoppingEventOccurred |
double | mStoppingTime |
A concrete one step ODE solver class that employs the backward Euler method. This numerical method is implicit and hence unconditionally stable.
Definition at line 51 of file BackwardEulerIvpOdeSolver.hpp.
BackwardEulerIvpOdeSolver::BackwardEulerIvpOdeSolver | ( | unsigned | sizeOfOdeSystem | ) |
Constructor.
sizeOfOdeSystem | the number of state variables in the ODE system |
Definition at line 210 of file BackwardEulerIvpOdeSolver.cpp.
References mForceUseOfNumericalJacobian, mJacobian, mNumericalJacobianEpsilon, mResidual, mSizeOfOdeSystem, and mUpdate.
BackwardEulerIvpOdeSolver::~BackwardEulerIvpOdeSolver | ( | ) |
Destructor.
Definition at line 229 of file BackwardEulerIvpOdeSolver.cpp.
References mJacobian, mResidual, mSizeOfOdeSystem, and mUpdate.
|
protectedvirtual |
Calculate the solution to the ODE system at the next timestep.
A usage example: BackwardEulerIvpOdeSolver mySolver; OdeSolution solution = mySolver.Solve(pMyOdeSystem, yInit, StartTime, EndTime, TimeStep, SamplingTime);
pAbstractOdeSystem | the ODE system to solve |
timeStep | dt |
time | the current time |
rCurrentYValues | the current (initial) state |
rNextYValues | the state at the next timestep |
Implements AbstractOneStepIvpOdeSolver.
Definition at line 167 of file BackwardEulerIvpOdeSolver.cpp.
References ComputeJacobian(), ComputeNorm(), ComputeResidual(), AbstractUntemplatedParameterisedSystem::GetNumberOfStateVariables(), mSizeOfOdeSystem, mUpdate, and SolveLinearSystem().
|
private |
Compute the Jacobian of the ODE system.
pAbstractOdeSystem | the ODE system to solve |
timeStep | dt |
time | the current time |
rCurrentYValues | the current (initial) state |
rCurrentGuess | current guess for the state at the next timestep |
Definition at line 54 of file BackwardEulerIvpOdeSolver.cpp.
References AbstractOdeSystemWithAnalyticJacobian::AnalyticJacobian(), ComputeNumericalJacobian(), AbstractOdeSystem::GetUseAnalyticJacobian(), mForceUseOfNumericalJacobian, mJacobian, and mSizeOfOdeSystem.
Referenced by CalculateNextYValue().
Compute the infinity/maximum norm of a vector. Used by the method CalculateNextYValue.
pVector | a pointer to a vector |
Definition at line 112 of file BackwardEulerIvpOdeSolver.cpp.
References mSizeOfOdeSystem.
Referenced by CalculateNextYValue().
|
private |
Compute the Jacobian of the ODE system numerically.
pAbstractOdeSystem | the ODE system to solve |
timeStep | dt |
time | the current time |
rCurrentYValues | the current (initial) state |
rCurrentGuess | current guess for the state at the next timestep |
Definition at line 125 of file BackwardEulerIvpOdeSolver.cpp.
References ComputeResidual(), mJacobian, mNumericalJacobianEpsilon, mResidual, and mSizeOfOdeSystem.
Referenced by ComputeJacobian().
|
private |
Compute the current residual.
pAbstractOdeSystem | the ODE system to solve |
timeStep | dt |
time | the current time |
rCurrentYValues | the current (initial) state |
rCurrentGuess | current guess for the state at the next timestep |
Definition at line 40 of file BackwardEulerIvpOdeSolver.cpp.
References AbstractOdeSystem::EvaluateYDerivatives(), mResidual, and mSizeOfOdeSystem.
Referenced by CalculateNextYValue(), and ComputeNumericalJacobian().
void BackwardEulerIvpOdeSolver::ForceUseOfNumericalJacobian | ( | ) |
Force the solver to use the numerical Jacobian even if the ODE system object provides an analytical Jacobian.
Definition at line 248 of file BackwardEulerIvpOdeSolver.cpp.
References mForceUseOfNumericalJacobian.
|
inline |
Public method used in archiving.
Definition at line 215 of file BackwardEulerIvpOdeSolver.hpp.
References mSizeOfOdeSystem.
|
inlineprivate |
Archive the abstract IVP Solver, never used directly - boost uses this.
archive | the archive |
version | the current version of this class |
Definition at line 63 of file BackwardEulerIvpOdeSolver.hpp.
References mForceUseOfNumericalJacobian, and mNumericalJacobianEpsilon.
void BackwardEulerIvpOdeSolver::SetEpsilonForNumericalJacobian | ( | double | epsilon | ) |
Set the epsilon to use in calculating the numerical Jacobian of the ODE system.
epsilon |
Definition at line 242 of file BackwardEulerIvpOdeSolver.cpp.
References mNumericalJacobianEpsilon.
|
private |
Solve a linear system of equations to update the current guess for the solution to the ODE system at the next timestep. Used by the method CalculateNextYValue.
Definition at line 85 of file BackwardEulerIvpOdeSolver.cpp.
References mJacobian, mResidual, mSizeOfOdeSystem, and mUpdate.
Referenced by CalculateNextYValue().
|
friend |
Needed for serialization.
Definition at line 55 of file BackwardEulerIvpOdeSolver.hpp.
|
private |
Whether to force the solver to use the numerical Jacobian even if the ODE system object provides an analytical Jacobian.
Definition at line 82 of file BackwardEulerIvpOdeSolver.hpp.
Referenced by BackwardEulerIvpOdeSolver(), ComputeJacobian(), ForceUseOfNumericalJacobian(), and serialize().
|
private |
Working memory : Jacobian matrix
Definition at line 94 of file BackwardEulerIvpOdeSolver.hpp.
Referenced by BackwardEulerIvpOdeSolver(), ComputeJacobian(), ComputeNumericalJacobian(), SolveLinearSystem(), and ~BackwardEulerIvpOdeSolver().
|
private |
The epsilon to use in calculating the numerical Jacobian of the ODE system.
Definition at line 76 of file BackwardEulerIvpOdeSolver.hpp.
Referenced by BackwardEulerIvpOdeSolver(), ComputeNumericalJacobian(), serialize(), and SetEpsilonForNumericalJacobian().
|
private |
Working memory : residual vector
Definition at line 91 of file BackwardEulerIvpOdeSolver.hpp.
Referenced by BackwardEulerIvpOdeSolver(), ComputeNumericalJacobian(), ComputeResidual(), SolveLinearSystem(), and ~BackwardEulerIvpOdeSolver().
|
private |
The number of state variables in the ODE system.
Definition at line 73 of file BackwardEulerIvpOdeSolver.hpp.
Referenced by BackwardEulerIvpOdeSolver(), CalculateNextYValue(), ComputeJacobian(), ComputeNorm(), ComputeNumericalJacobian(), ComputeResidual(), GetSystemSize(), SolveLinearSystem(), and ~BackwardEulerIvpOdeSolver().
|
private |
Working memory : update vector
Definition at line 97 of file BackwardEulerIvpOdeSolver.hpp.
Referenced by BackwardEulerIvpOdeSolver(), CalculateNextYValue(), SolveLinearSystem(), and ~BackwardEulerIvpOdeSolver().