LifeV
HeartMonodomainData Class Reference

#include <HeartMonodomainData.hpp>

+ Inheritance diagram for HeartMonodomainData:
+ Collaboration diagram for HeartMonodomainData:

Private Attributes

region_Type M_reducedConductivityBox
 
region_Type M_reducedConductivityCylinder
 
region_Type M_reducedConductivitySphere
 
bool M_hasFibers
 
UInt M_verbose
 
Int M_heartDiffusionFactor
 
Real M_diffusivity
 
Real M_longitudinalConductivity
 
Real M_membraneCapacitance
 
Real M_transversalConductivity
 
Real M_volumeSurfaceRatio
 
Real M_conductivityRatio
 
std::string M_fibersDirectory
 
std::string M_fibersFile
 
std::string M_postProcessingDirectory
 
std::string M_uOrder
 full name More...
 

Public Types

typedef std::function< Real(Real const &x, Real const &y, Real const &z, Real const &t, ID const &id, Real const &) > region_Type
 

Constructor & Destructor

 HeartMonodomainData ()
 Constructors. More...
 
 HeartMonodomainData (std::shared_ptr< HeartFunctors > heart)
 
 HeartMonodomainData (const HeartMonodomainData &dataMonodomain)
 
virtual ~HeartMonodomainData ()
 

Operators

HeartMonodomainDataoperator= (const HeartMonodomainData &dataMonodomain)
 

Methods

void showMe (std::ostream &output=std::cout)
 output: show the data used for the simulation More...
 

Set Methods

void setup (const GetPot &dataFile)
 external setup: set all the data for the simulation More...
 

Get Methods

const region_TypereducedConductivityBox () const
 
const region_TypereducedConductivityCylinder () const
 
const region_TypereducedConductivitySphere () const
 
const UIntverbose () const
 verbose More...
 
std::string uOrder () const
 FE space order. More...
 
const RealvolumeSurfaceRatio () const
 Chi. More...
 
const RealconductivityRatio () const
 lambda, key parameter in the derivation of Monodomain equations More...
 
std::string fibersFile () const
 fiber File More...
 
const IntheartDiffusionFactor () const
 
bool hasFibers () const
 
const ReallongitudinalConductivity () const
 sigma_l More...
 
const RealtransversalConductivity () const
 sigma_t More...
 
const RealmembraneCapacitance () const
 Cm. More...
 
const Realdiffusivity () const
 D. More...
 
std::string postProcessingDirectory () const
 Post_dir. More...
 

Additional Inherited Members

- Public Member Functions inherited from MeshData
 MeshData ()
 Empty Constructor. More...
 
 MeshData (const GetPot &dataFile, const std::string &section="space_discretization")
 Constructor. More...
 
 MeshData (const MeshData &meshData)
 Copy constructor. More...
 
virtual ~MeshData ()
 Virtual destructor. More...
 
void setup (const GetPot &dataFile, const std::string &section)
 Read the dataFile and set all the members. More...
 
void setup (const Teuchos::ParameterList &meshParameters)
 Set all members using a Teuchos ParameterList. More...
 
virtual void showMe (std::ostream &output=std::cout) const
 Display the values. More...
 
void setMeshDir (const std::string &dir)
 
void setMeshFile (const std::string &file)
 
void setMeshType (const std::string &type)
 
void setMOrder (const std::string &order)
 
void setVerbose (const bool &isVerbose)
 
const std::string & meshDir () const
 
const std::string & meshFile () const
 
const std::string & meshType () const
 
const std::string & mOrder () const
 
const bool & verbose () const
 
- Public Member Functions inherited from TimeData
 TimeData ()
 Empty Constructor. More...
 
 TimeData (const GetPot &dataFile, const std::string &section="time_discretization")
 Constructor. More...
 
 TimeData (const TimeData &TimeData)
 Copy constructor. More...
 
virtual ~TimeData ()
 Virtual destructor. More...
 
void setup (const GetPot &dfile, const std::string &section="time_discretization")
 Read the dataFile and set all the internal quantities. More...
 
void updateTime ()
 Update the time by a timestep. More...
 
bool canAdvance ()
 Return if we can make a new timestep. More...
 
bool isFirstTimeStep ()
 Return if it is the initial time step. More...
 
bool isLastTimeStep ()
 Return if it is the last time step. More...
 
void showMe (std::ostream &output=std::cout) const
 Display general information about the content of the class. More...
 
Real round (const Real &n, const Int &decimal=10) const
 
void setInitialTime (const Real &initialTime)
 Set the initial time step. More...
 
void setEndTime (const Real &endTime)
 Set the final time step. More...
 
void setTime (const Real &time)
 Set the present time of the simulation. More...
 
void setTimeStep (const Real &timeStep)
 Set the initial time step. More...
 
void setTimeStepNumber (const UInt &timeStepNumber)
 Set the time step number. More...
 
const RealinitialTime () const
 Get the initial time step. More...
 
const RealendTime () const
 Get the final time step. More...
 
const RealperiodTime () const
 Get the period. More...
 
const Realtime () const
 Get the present time. More...
 
Real leftTime () const
 Get the time left. More...
 
Real elapsedTime () const
 Get the elapsed time. More...
 
Real inCycleTime () const
 Get the present time shifted inside the first cycle (i.e. More...
 
Real previousTime () const
 Get the previous time. More...
 
Real nextTime () const
 Get the next time. More...
 
const RealtimeStep () const
 Get the time step used for advancing. More...
 
const UInttimeStepNumber () const
 Get the number of time step performed. More...
 

Detailed Description

Definition at line 54 of file HeartMonodomainData.hpp.

Member Typedef Documentation

◆ region_Type

typedef std::function< Real ( Real const& x, Real const& y, Real const& z, Real const& t, ID const& id, Real const&) > region_Type

Definition at line 69 of file HeartMonodomainData.hpp.

Constructor & Destructor Documentation

◆ HeartMonodomainData() [1/3]

Constructors.

Definition at line 59 of file HeartMonodomainData.cpp.

+ Here is the caller graph for this function:

◆ HeartMonodomainData() [2/3]

HeartMonodomainData ( std::shared_ptr< HeartFunctors heart)

Definition at line 47 of file HeartMonodomainData.cpp.

+ Here is the caller graph for this function:

◆ HeartMonodomainData() [3/3]

HeartMonodomainData ( const HeartMonodomainData dataMonodomain)

Definition at line 79 of file HeartMonodomainData.cpp.

+ Here is the caller graph for this function:

◆ ~HeartMonodomainData()

virtual ~HeartMonodomainData ( )
inlinevirtual

Definition at line 85 of file HeartMonodomainData.hpp.

Member Function Documentation

◆ operator=()

HeartMonodomainData & operator= ( const HeartMonodomainData dataMonodomain)

Definition at line 104 of file HeartMonodomainData.cpp.

◆ showMe()

void showMe ( std::ostream &  output = std::cout)

output: show the data used for the simulation

Definition at line 169 of file HeartMonodomainData.cpp.

◆ setup()

void setup ( const GetPot dataFile)

external setup: set all the data for the simulation

Definition at line 129 of file HeartMonodomainData.cpp.

◆ reducedConductivityBox()

const region_Type& reducedConductivityBox ( ) const
inline

Definition at line 116 of file HeartMonodomainData.hpp.

◆ reducedConductivityCylinder()

const region_Type& reducedConductivityCylinder ( ) const
inline

Definition at line 121 of file HeartMonodomainData.hpp.

◆ reducedConductivitySphere()

const region_Type& reducedConductivitySphere ( ) const
inline

Definition at line 126 of file HeartMonodomainData.hpp.

◆ verbose()

const UInt& verbose ( ) const
inline

verbose

Definition at line 132 of file HeartMonodomainData.hpp.

◆ uOrder()

std::string uOrder ( ) const
inline

FE space order.

Definition at line 138 of file HeartMonodomainData.hpp.

◆ volumeSurfaceRatio()

const Real& volumeSurfaceRatio ( ) const
inline

Chi.

Definition at line 144 of file HeartMonodomainData.hpp.

+ Here is the caller graph for this function:

◆ conductivityRatio()

const Real& conductivityRatio ( ) const
inline

lambda, key parameter in the derivation of Monodomain equations

Definition at line 150 of file HeartMonodomainData.hpp.

◆ fibersFile()

std::string fibersFile ( ) const
inline

fiber File

Definition at line 156 of file HeartMonodomainData.hpp.

◆ heartDiffusionFactor()

const Int& heartDiffusionFactor ( ) const
inline

Definition at line 162 of file HeartMonodomainData.hpp.

+ Here is the caller graph for this function:

◆ hasFibers()

bool hasFibers ( ) const
inline

Definition at line 168 of file HeartMonodomainData.hpp.

+ Here is the caller graph for this function:

◆ longitudinalConductivity()

const Real& longitudinalConductivity ( ) const
inline

sigma_l

Definition at line 174 of file HeartMonodomainData.hpp.

◆ transversalConductivity()

const Real& transversalConductivity ( ) const
inline

sigma_t

Definition at line 180 of file HeartMonodomainData.hpp.

◆ membraneCapacitance()

const Real& membraneCapacitance ( ) const
inline

Cm.

Definition at line 186 of file HeartMonodomainData.hpp.

+ Here is the caller graph for this function:

◆ diffusivity()

const Real& diffusivity ( ) const
inline

D.

Definition at line 192 of file HeartMonodomainData.hpp.

◆ postProcessingDirectory()

std::string postProcessingDirectory ( ) const
inline

Post_dir.

Definition at line 198 of file HeartMonodomainData.hpp.

Field Documentation

◆ M_reducedConductivityBox

region_Type M_reducedConductivityBox
private

Definition at line 213 of file HeartMonodomainData.hpp.

◆ M_reducedConductivityCylinder

region_Type M_reducedConductivityCylinder
private

Definition at line 214 of file HeartMonodomainData.hpp.

◆ M_reducedConductivitySphere

region_Type M_reducedConductivitySphere
private

Definition at line 215 of file HeartMonodomainData.hpp.

◆ M_hasFibers

bool M_hasFibers
private

Definition at line 217 of file HeartMonodomainData.hpp.

◆ M_verbose

UInt M_verbose
private

Definition at line 219 of file HeartMonodomainData.hpp.

◆ M_heartDiffusionFactor

Int M_heartDiffusionFactor
private

Definition at line 221 of file HeartMonodomainData.hpp.

◆ M_diffusivity

Real M_diffusivity
private

Definition at line 223 of file HeartMonodomainData.hpp.

◆ M_longitudinalConductivity

Real M_longitudinalConductivity
private

Definition at line 224 of file HeartMonodomainData.hpp.

◆ M_membraneCapacitance

Real M_membraneCapacitance
private

Definition at line 225 of file HeartMonodomainData.hpp.

◆ M_transversalConductivity

Real M_transversalConductivity
private

Definition at line 226 of file HeartMonodomainData.hpp.

◆ M_volumeSurfaceRatio

Real M_volumeSurfaceRatio
private

Definition at line 227 of file HeartMonodomainData.hpp.

◆ M_conductivityRatio

Real M_conductivityRatio
private

Definition at line 228 of file HeartMonodomainData.hpp.

◆ M_fibersDirectory

std::string M_fibersDirectory
private

Definition at line 230 of file HeartMonodomainData.hpp.

◆ M_fibersFile

std::string M_fibersFile
private

Definition at line 231 of file HeartMonodomainData.hpp.

◆ M_postProcessingDirectory

std::string M_postProcessingDirectory
private

Definition at line 232 of file HeartMonodomainData.hpp.

◆ M_uOrder

std::string M_uOrder
private

full name

Definition at line 233 of file HeartMonodomainData.hpp.


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