Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractOdeSystemForCoupledPdeSystem Class Reference

#include <AbstractOdeSystemForCoupledPdeSystem.hpp>

+ Inheritance diagram for AbstractOdeSystemForCoupledPdeSystem:
+ Collaboration diagram for AbstractOdeSystemForCoupledPdeSystem:

Public Member Functions

 AbstractOdeSystemForCoupledPdeSystem (unsigned numberOfStateVariables=0, unsigned pdeSolutionSize=0)
 
std::vector< double > & rGetPdeSolution ()
 
void SetPdeSolution (std::vector< double > pdeSolution)
 
unsigned GetPdeSolutionSize ()
 
- Public Member Functions inherited from AbstractOdeSystem
 AbstractOdeSystem (unsigned numberOfStateVariables)
 
virtual ~AbstractOdeSystem ()
 
virtual void EvaluateYDerivatives (double time, const std::vector< double > &rY, std::vector< double > &rDY)=0
 
virtual bool CalculateStoppingEvent (double time, const std::vector< double > &rY)
 
virtual double CalculateRootFunction (double time, const std::vector< double > &rY)
 
bool GetUseAnalyticJacobian ()
 
const std::vector< double > & rGetConstStateVariables () const
 
- Public Member Functions inherited from AbstractParameterisedSystem< std::vector< double > >
 AbstractParameterisedSystem (unsigned numberOfStateVariables)
 
std::vector< double > & rGetStateVariables ()
 
std::vector< doubleGetStateVariables ()
 
void SetStateVariables (const std::vector< double > &rStateVariables)
 
double GetStateVariable (unsigned index) const
 
double GetStateVariable (const std::string &rName) const
 
void SetStateVariable (unsigned index, double newValue)
 
void SetStateVariable (const std::string &rName, double newValue)
 
virtual void VerifyStateVariables ()
 
void SetDefaultInitialConditions (const std::vector< double > &rInitialConditions)
 
void SetDefaultInitialCondition (unsigned index, double initialCondition)
 
std::vector< doubleGetInitialConditions () const
 
void ResetToInitialConditions ()
 
double GetParameter (unsigned index) const
 
double GetParameter (const std::string &rName) const
 
void SetParameter (const std::string &rName, double value)
 
void SetParameter (unsigned index, double value)
 
double GetAnyVariable (unsigned index, double time=0.0, std::vector< double > *pDerivedQuantities=NULL)
 
double GetAnyVariable (const std::string &rName, double time=0.0, std::vector< double > *pDerivedQuantities=NULL)
 
void SetAnyVariable (unsigned index, double value)
 
void SetAnyVariable (const std::string &rName, double value)
 
virtual std::vector< doubleComputeDerivedQuantities (double time, const std::vector< double > &rState)
 
std::vector< doubleComputeDerivedQuantitiesFromCurrentState (double time)
 
- Public Member Functions inherited from AbstractUntemplatedParameterisedSystem
 AbstractUntemplatedParameterisedSystem (unsigned numberOfStateVariables)
 
virtual ~AbstractUntemplatedParameterisedSystem ()
 
boost::shared_ptr< const AbstractOdeSystemInformationGetSystemInformation () const
 
std::string GetSystemName () const
 
unsigned GetNumberOfAttributes () const
 
bool HasAttribute (const std::string &rName) const
 
double GetAttribute (const std::string &rName) const
 
unsigned GetNumberOfStateVariables () const
 
const std::vector< std::string > & rGetStateVariableNames () const
 
const std::vector< std::string > & rGetStateVariableUnits () const
 
unsigned GetStateVariableIndex (const std::string &rName) const
 
bool HasStateVariable (const std::string &rName) const
 
std::string GetStateVariableUnits (unsigned index) const
 
unsigned GetNumberOfParameters () const
 
const std::vector< std::string > & rGetParameterNames () const
 
const std::vector< std::string > & rGetParameterUnits () const
 
unsigned GetParameterIndex (const std::string &rName) const
 
bool HasParameter (const std::string &rName) const
 
std::string GetParameterUnits (unsigned index) const
 
unsigned GetNumberOfDerivedQuantities () const
 
const std::vector< std::string > & rGetDerivedQuantityNames () const
 
const std::vector< std::string > & rGetDerivedQuantityUnits () const
 
unsigned GetDerivedQuantityIndex (const std::string &rName) const
 
bool HasDerivedQuantity (const std::string &rName) const
 
std::string GetDerivedQuantityUnits (unsigned index) const
 
unsigned GetAnyVariableIndex (const std::string &rName) const
 
bool HasAnyVariable (const std::string &rName) const
 
std::string GetAnyVariableUnits (unsigned index) const
 
std::string GetAnyVariableUnits (const std::string &rName) const
 

Protected Attributes

std::vector< doublemPdeSolution
 
unsigned mPdeSolutionSize
 
- Protected Attributes inherited from AbstractOdeSystem
bool mUseAnalyticJacobian
 
- Protected Attributes inherited from AbstractParameterisedSystem< std::vector< double > >
std::vector< doublemStateVariables
 
std::vector< doublemParameters
 
- Protected Attributes inherited from AbstractUntemplatedParameterisedSystem
unsigned mNumberOfStateVariables
 
boost::shared_ptr< AbstractOdeSystemInformationmpSystemInfo
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractParameterisedSystem< std::vector< double > >
std::string DumpState (const std::string &rMessage)
 
std::string DumpState (const std::string &rMessage, std::vector< double > Y)
 
std::string DumpState (const std::string &rMessage, std::vector< double > Y, double time)
 
void CheckParametersOnLoad (const std::vector< double > &rParameters, const std::vector< std::string > &rParameterNames)
 

Detailed Description

Represents an ODE system of the form

d/dt (v_j) = g_j(x, u_1, ..., u_p, v_1, ..., v_q), j=1,...,q,

where the variables u_1, ..., u_p are assumed to satisfy a coupled PDE system of the form

d/dt (u_i) = div (D(x) grad (u_i)) + f_i (x, u_1, ..., u_p, v_1, ..., v_q), i=1,...,p.

Such systems may be solved using LinearParabolicPdeSystemWithCoupledOdeSystemSolver.

Definition at line 54 of file AbstractOdeSystemForCoupledPdeSystem.hpp.

Constructor & Destructor Documentation

◆ AbstractOdeSystemForCoupledPdeSystem()

AbstractOdeSystemForCoupledPdeSystem::AbstractOdeSystemForCoupledPdeSystem ( unsigned  numberOfStateVariables = 0,
unsigned  pdeSolutionSize = 0 
)
inline

Constructor.

Parameters
numberOfStateVariablesthe number of state variables in the ODE system (defaults to 0)
pdeSolutionSizethe size of the PDE solution at a point in space (defaults to 0)

Definition at line 76 of file AbstractOdeSystemForCoupledPdeSystem.hpp.

References mPdeSolution.

Member Function Documentation

◆ GetPdeSolutionSize()

unsigned AbstractOdeSystemForCoupledPdeSystem::GetPdeSolutionSize ( )
inline
Returns
mPdeSolutionSize.

Definition at line 109 of file AbstractOdeSystemForCoupledPdeSystem.hpp.

References mPdeSolutionSize.

◆ rGetPdeSolution()

std::vector< double > & AbstractOdeSystemForCoupledPdeSystem::rGetPdeSolution ( )
inline
Returns
mPdeSolution.

Definition at line 87 of file AbstractOdeSystemForCoupledPdeSystem.hpp.

References mPdeSolution.

◆ SetPdeSolution()

void AbstractOdeSystemForCoupledPdeSystem::SetPdeSolution ( std::vector< double pdeSolution)
inline

Set mPdeSolution.

Parameters
pdeSolutionthe PDE solution at a point in space

Definition at line 97 of file AbstractOdeSystemForCoupledPdeSystem.hpp.

References EXCEPTION, mPdeSolution, and mPdeSolutionSize.

Member Data Documentation

◆ mPdeSolution

std::vector<double> AbstractOdeSystemForCoupledPdeSystem::mPdeSolution
protected

◆ mPdeSolutionSize

unsigned AbstractOdeSystemForCoupledPdeSystem::mPdeSolutionSize
protected

The size of the PDE solution at a point in space.

Definition at line 66 of file AbstractOdeSystemForCoupledPdeSystem.hpp.

Referenced by OdeSystemForCoupledHeatEquation::EvaluateYDerivatives(), GetPdeSolutionSize(), and SetPdeSolution().


The documentation for this class was generated from the following file: