svFSIplus
Public Member Functions | Public Attributes | List of all members
CepModFn Class Reference

This module defines data structures for Fitzhugh-Nagumo cellular activation model for cardiac electrophysiology. More...

#include <CepModFn.h>

Public Member Functions

 CepModFn ()
 
void getf (const int n, const Vector< double > &X, Vector< double > &f, const double fext)
 
void getj (const int n, const Vector< double > &X, Array< double > &JAC)
 
void init (const int nX, Vector< double > &X)
 SUBROUTINE FN_INIT0(nX, X) More...
 
void init (const int nX, Vector< double > &X, double X0)
 SUBROUTINE FN_INITS(nX, X, X0) More...
 
void init (const int nX, Vector< double > &X, Vector< double > &X0)
 SUBROUTINE FN_INITV(nX, X, X0) More...
 
void integ_cn2 (const int nX, Vector< double > &Xn, const double Ts, const double Ti, const double Istim, Vector< int > &IPAR, Vector< double > &RPAR)
 Time integration performed using Crank-Nicholson method. More...
 
void integ_fe (const int nX, Vector< double > &X, const double Ts, const double Ti, const double Istim)
 Time integration performed using Forward Euler method. More...
 
void integ_rk (const int nX, Vector< double > &X, const double Ts, const double Ti, const double Istim)
 Time integration performed using 4th order Runge-Kutta method. More...
 

Public Attributes

double Vscale = 1.0
 Voltage scaling. More...
 
double Tscale = 1.0
 Time scaling. More...
 
double Voffset = 0.0
 Voltage offset parameter. More...
 
double alpha = -0.50
 Model parameters. More...
 
double a = 0.0
 
double b = -0.60
 
double c = 50.0
 

Detailed Description

This module defines data structures for Fitzhugh-Nagumo cellular activation model for cardiac electrophysiology.

Copyright (c) Stanford University, The Regents of the University of California, and others.

All Rights Reserved.

See Copyright-SimVascular.txt for additional details.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The classes defined here duplicate the data structures in the Fortran FNMOD module defined in CEPMOD_FN.f and PARAMS_FN.f files.

Constructor & Destructor Documentation

◆ CepModFn()

CepModFn::CepModFn ( )

Copyright (c) Stanford University, The Regents of the University of California, and others.

All Rights Reserved.

See Copyright-SimVascular.txt for additional details.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Member Function Documentation

◆ init() [1/3]

void CepModFn::init ( const int  nX,
Vector< double > &  X 
)

SUBROUTINE FN_INIT0(nX, X)

◆ init() [2/3]

void CepModFn::init ( const int  nX,
Vector< double > &  X,
double  X0 
)

SUBROUTINE FN_INITS(nX, X, X0)

◆ init() [3/3]

void CepModFn::init ( const int  nX,
Vector< double > &  X,
Vector< double > &  X0 
)

SUBROUTINE FN_INITV(nX, X, X0)

◆ integ_cn2()

void CepModFn::integ_cn2 ( const int  nX,
Vector< double > &  Xn,
const double  Ts,
const double  Ti,
const double  Istim,
Vector< int > &  IPAR,
Vector< double > &  RPAR 
)

Time integration performed using Crank-Nicholson method.

◆ integ_fe()

void CepModFn::integ_fe ( const int  nX,
Vector< double > &  X,
const double  Ts,
const double  Ti,
const double  Istim 
)

Time integration performed using Forward Euler method.

◆ integ_rk()

void CepModFn::integ_rk ( const int  nX,
Vector< double > &  X,
const double  Ts,
const double  Ti,
const double  Istim 
)

Time integration performed using 4th order Runge-Kutta method.

Replicates 'SUBROUTINE AP_INTEGRK(nX, X, Ts, Ti, Istim, Ksac)' defined in 'CEPMOD_AP.f'.

Member Data Documentation

◆ alpha

double CepModFn::alpha = -0.50

Model parameters.

◆ Tscale

double CepModFn::Tscale = 1.0

Time scaling.

◆ Voffset

double CepModFn::Voffset = 0.0

Voltage offset parameter.

◆ Vscale

double CepModFn::Vscale = 1.0

Voltage scaling.


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