OpenCMISS-Iron Internal API Documentation
bioelectric_routines Module Reference

This module handles all bioelectric class routines. More...

Functions/Subroutines

subroutine, public bioelectric_control_loop_post_loop (CONTROL_LOOP, ERR, ERROR,)
 Executes after each loop of a control loop for bioelectric problems, i.e., after each time step for a time loop. More...
 
subroutine, public bioelectric_equationssetspecificationset (equationsSet, specification, err, error,)
 Sets the problem specification for a bioelectric equation set class. More...
 
subroutine, public bioelectric_finite_element_calculate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Calculates the element stiffness matries and rhs vector for the given element number for a bioelectric class finite element equation set. More...
 
subroutine, public bioelectric_equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the equations set for a bioelectric equations set class. More...
 
subroutine, public bioelectric_equationssetsolutionmethodset (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
 Sets/changes the solution method for a bioelectric equation set class. More...
 
subroutine, public bioelectric_pre_solve (SOLVER, ERR, ERROR,)
 Perform pre-solve actions for the bioelectrics problem class. More...
 
subroutine, public bioelectric_post_solve (SOLVER, ERR, ERROR,)
 Performs post solve actions for a bioelectrics problem class. More...
 
subroutine, public bioelectric_problemspecificationset (problem, problemSpecification, err, error,)
 Sets the problem specification for a bioelectric problem class. More...
 
subroutine, public bioelectric_problem_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,)
 Sets up the problem for a bioelectric problem class. More...
 

Detailed Description

This module handles all bioelectric class routines.

Function/Subroutine Documentation

subroutine, public bioelectric_routines::bioelectric_control_loop_post_loop ( type(control_loop_type), pointer  CONTROL_LOOP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Executes after each loop of a control loop for bioelectric problems, i.e., after each time step for a time loop.

Parameters
control_loopA pointer to the control loop to solve.
[out]errThe error code
[out]errorThe error string

Definition at line 95 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_control_loop_post_loop(), base_routines::enters(), base_routines::exits(), problem_constants::problem_bidomain_equation_type, problem_constants::problem_control_time_loop_type, problem_constants::problem_monodomain_equation_type, and problem_constants::problem_monodomain_strang_splitting_equation_type.

subroutine, public bioelectric_routines::bioelectric_equations_set_setup ( type(equations_set_type), pointer  EQUATIONS_SET,
type(equations_set_setup_type), intent(inout)  EQUATIONS_SET_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the equations set for a bioelectric equations set class.

Parameters
equations_setA pointer to the equations set
[in,out]equations_set_setupThe equations set setup information
[out]errThe error code
[out]errorThe error string

Definition at line 237 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_equationssetsetup(), base_routines::enters(), equations_set_constants::equations_set_bidomain_equation_type, equations_set_constants::equations_set_monodomain_equation_type, and base_routines::exits().

Referenced by equations_set_routines::equations_set_setup().

subroutine, public bioelectric_routines::bioelectric_equationssetsolutionmethodset ( type(equations_set_type), pointer  EQUATIONS_SET,
integer(intg), intent(in)  SOLUTION_METHOD,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets/changes the solution method for a bioelectric equation set class.

Parameters
equations_setA pointer to the equations set to set the solution method for
[in]solution_methodThe solution method to set
[out]errThe error code
[out]errorThe error string

Definition at line 281 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_equationssetsolutionmethodset(), base_routines::enters(), equations_set_constants::equations_set_bidomain_equation_type, equations_set_constants::equations_set_monodomain_equation_type, and base_routines::exits().

Referenced by equations_set_routines::equations_set_solution_method_set().

subroutine, public bioelectric_routines::bioelectric_equationssetspecificationset ( type(equations_set_type), pointer  equationsSet,
integer(intg), dimension(:), intent(in)  specification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Sets the problem specification for a bioelectric equation set class.

Parameters
equationssetA pointer to the equations set
[in]specificationThe equations specification to set
[out]errThe error code
[out]errorThe error string

Definition at line 149 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_equationssetspecificationset(), base_routines::enters(), equations_set_constants::equations_set_bidomain_equation_type, equations_set_constants::equations_set_monodomain_equation_type, base_routines::errors(), and base_routines::exits().

Referenced by equations_set_routines::equationsset_specificationset().

subroutine, public bioelectric_routines::bioelectric_finite_element_calculate ( type(equations_set_type), pointer  EQUATIONS_SET,
integer(intg), intent(in)  ELEMENT_NUMBER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Calculates the element stiffness matries and rhs vector for the given element number for a bioelectric class finite element equation set.

Parameters
equations_setA pointer to the equations set
[in]element_numberThe element number to calcualate
[out]errThe error code
[out]errorThe error string

Definition at line 193 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_equation_finite_element_calculate(), base_routines::enters(), equations_set_constants::equations_set_bidomain_equation_type, equations_set_constants::equations_set_monodomain_equation_type, and base_routines::exits().

Referenced by equations_set_routines::equations_set_finite_element_calculate().

subroutine, public bioelectric_routines::bioelectric_post_solve ( type(solver_type), pointer  SOLVER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public bioelectric_routines::bioelectric_pre_solve ( type(solver_type), pointer  SOLVER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Perform pre-solve actions for the bioelectrics problem class.

Parameters
solverA pointer to the solver
[out]errThe error code
[out]errorThe error string

Definition at line 326 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_pre_solve(), base_routines::enters(), base_routines::exits(), problem_constants::problem_bidomain_equation_type, problem_constants::problem_monodomain_equation_type, and problem_constants::problem_monodomain_strang_splitting_equation_type.

subroutine, public bioelectric_routines::bioelectric_problem_setup ( type(problem_type), pointer  PROBLEM,
type(problem_setup_type), intent(inout)  PROBLEM_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the problem for a bioelectric problem class.

Parameters
problemA pointer to the problem
[in,out]problem_setupThe problem setup information
[out]errThe error code
[out]errorThe error string

Definition at line 493 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_equation_problem_setup(), base_routines::enters(), base_routines::exits(), problem_constants::problem_bidomain_equation_type, problem_constants::problem_monodomain_equation_type, and problem_constants::problem_monodomain_strang_splitting_equation_type.

subroutine, public bioelectric_routines::bioelectric_problemspecificationset ( type(problem_type), pointer  problem,
integer(intg), dimension(:), intent(in)  problemSpecification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Sets the problem specification for a bioelectric problem class.

Parameters
problemA pointer to the problem to set the specification for.
[in]problemspecificationThe problem specification to set.
[out]errThe error code
[out]errorThe error string

Definition at line 447 of file bioelectric_routines.f90.

References biodomain_equation_routines::biodomain_problemspecificationset(), base_routines::enters(), base_routines::errors(), base_routines::exits(), problem_constants::problem_bidomain_equation_type, problem_constants::problem_monodomain_equation_type, and problem_constants::problem_monodomain_strang_splitting_equation_type.