Convenience base class for active stress generation models providing numerical differentiation. More...

#include <membraneModels.hh>

Detailed Description

template<class Derived, int n, int m>
struct Kaskade::ActiveStressModelBase< Derived, n, m >

Convenience base class for active stress generation models providing numerical differentiation.

This models the active stress generation of myocardial tissue by pointwise ODEs of the form

\[ \dot s = f(s,e), \quad a = g(s), \]

where \( s \) are the internal states, \( e \) are the trigger variables driving the activation, and \( a \) is the actual stress generated.

Template Parameters

n	the number of internal state variables
m	the number of external trigger variables

Definition at line 672 of file membraneModels.hh.

Public Types
typedef Dune::FieldVector< double, nState >	State
	Vector type holding the internal variables. More...

typedef Dune::FieldVector< double, nTrigger >	Trigger
	Vector type holding trigger variables. More...

typedef Dune::FieldMatrix< double, nState, nState >	StateJacobian
	Matrix type for the Jacobian of the State dynamics. More...

typedef Dune::FieldMatrix< double, nState, nTrigger >	StateTriggerJacobian
	Matrix type for the derivative of the state dynamics wrt the triggers. More...

Public Member Functions
	ActiveStressModelBase ()
	Default constructor. More...

	ActiveStressModelBase (std::string const &name, State const &fix_)
	Constructor specifying the model data. More...

std::string const &	name () const
	Human-readable name of the active stress model. More...

State const &	restState () const
	Value of the resting state fixed point. More...

StateJacobian	state_ds (State const &s, Trigger const &t) const
	The deriviative of internal state dynamics wrt state variables. More...

StateTriggerJacobian	state_dt (State const &s, Trigger const &t) const
	The deriviative of internal state dynamics wrt trigger variables. More...

State	stress_ds (State const &s) const
	The derivative of stress wrt state variables. More...

Static Public Attributes
static int const	nState = n
	Number of internal state variables. More...

static int const	nTrigger = m
	Number of trigger variables. More...

Member Typedef Documentation

◆ State

template<class Derived , int n, int m>

typedef Dune::FieldVector<double,nState> Kaskade::ActiveStressModelBase< Derived, n, m >::State

Vector type holding the internal variables.

Definition at line 687 of file membraneModels.hh.

◆ StateJacobian

template<class Derived , int n, int m>

typedef Dune::FieldMatrix<double,nState,nState> Kaskade::ActiveStressModelBase< Derived, n, m >::StateJacobian

Matrix type for the Jacobian of the State dynamics.

Definition at line 697 of file membraneModels.hh.

◆ StateTriggerJacobian

template<class Derived , int n, int m>

typedef Dune::FieldMatrix<double,nState,nTrigger> Kaskade::ActiveStressModelBase< Derived, n, m >::StateTriggerJacobian

Matrix type for the derivative of the state dynamics wrt the triggers.

Definition at line 702 of file membraneModels.hh.

◆ Trigger

template<class Derived , int n, int m>

typedef Dune::FieldVector<double,nTrigger> Kaskade::ActiveStressModelBase< Derived, n, m >::Trigger

Vector type holding trigger variables.

Definition at line 692 of file membraneModels.hh.

Constructor & Destructor Documentation

◆ ActiveStressModelBase() [1/2]

template<class Derived , int n, int m>

Kaskade::ActiveStressModelBase< Derived, n, m >::ActiveStressModelBase ( )

inline

Default constructor.

Definition at line 707 of file membraneModels.hh.

◆ ActiveStressModelBase() [2/2]

template<class Derived , int n, int m>

Kaskade::ActiveStressModelBase< Derived, n, m >::ActiveStressModelBase	(	std::string const &	name,
		State const &	fix_
	)

inline

Constructor specifying the model data.

Parameters

name	the human-readable model name
fix	the resting state of the state variables

Definition at line 714 of file membraneModels.hh.

Member Function Documentation

◆ name()

template<class Derived , int n, int m>

std::string const & Kaskade::ActiveStressModelBase< Derived, n, m >::name ( ) const

inline

Human-readable name of the active stress model.

Definition at line 719 of file membraneModels.hh.

◆ restState()

template<class Derived , int n, int m>

State const & Kaskade::ActiveStressModelBase< Derived, n, m >::restState ( ) const

inline

Value of the resting state fixed point.

Definition at line 724 of file membraneModels.hh.

◆ state_ds()

template<class Derived , int n, int m>

StateJacobian Kaskade::ActiveStressModelBase< Derived, n, m >::state_ds	(	State const &	s,
		Trigger const &	t
	)		const

inline

The deriviative of internal state dynamics wrt state variables.

Parameters

s	state variables
t	trigger variables

Definition at line 731 of file membraneModels.hh.

◆ state_dt()

template<class Derived , int n, int m>

StateTriggerJacobian Kaskade::ActiveStressModelBase< Derived, n, m >::state_dt	(	State const &	s,
		Trigger const &	t
	)		const

inline

The deriviative of internal state dynamics wrt trigger variables.

Parameters

s	state variables
t	trigger variables

Definition at line 752 of file membraneModels.hh.

◆ stress_ds()

template<class Derived , int n, int m>

State Kaskade::ActiveStressModelBase< Derived, n, m >::stress_ds ( State const & s ) const

inline

The derivative of stress wrt state variables.

Parameters

s	state variables
t	trigger variables

Definition at line 774 of file membraneModels.hh.

Member Data Documentation

◆ nState

template<class Derived , int n, int m>

int const Kaskade::ActiveStressModelBase< Derived, n, m >::nState = n

static

Number of internal state variables.

Definition at line 677 of file membraneModels.hh.

Referenced by Kaskade::ActiveStressModelBase< Derived, n, m >::state_ds(), Kaskade::ActiveStressModelBase< Derived, n, m >::state_dt(), and Kaskade::ActiveStressModelBase< Derived, n, m >::stress_ds().

◆ nTrigger

template<class Derived , int n, int m>

int const Kaskade::ActiveStressModelBase< Derived, n, m >::nTrigger = m

static

Number of trigger variables.

Definition at line 682 of file membraneModels.hh.

Referenced by Kaskade::ActiveStressModelBase< Derived, n, m >::state_dt().

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

membraneModels.hh

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ State

◆ StateJacobian

◆ StateTriggerJacobian

◆ Trigger

Constructor & Destructor Documentation

◆ ActiveStressModelBase() [1/2]

◆ ActiveStressModelBase() [2/2]

Member Function Documentation

◆ name()

◆ restState()

◆ state_ds()

◆ state_dt()

◆ stress_ds()

Member Data Documentation

◆ nState

◆ nTrigger