OpenCMISS-Iron Internal API Documentation
diffusion_diffusion_routines Module Reference

This module handles all routines pertaining to diffusion coupled to diffusion. More...

Functions/Subroutines

subroutine, public diffusiondiffusion_equationssetsolutionmethodset (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
 Sets/changes the solution method for a diffusion-diffusion equation type of a multi physics equations set class. More...
 
subroutine, public diffusion_diffusion_equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the diffusion-diffusion coupled equation. More...
 
subroutine, public diffusiondiffusion_finiteelementcalculate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Calculates the element stiffness matrices and RHS for a coupled diffusion-diffusion equation finite element equations set. More...
 
subroutine, public diffusiondiffusion_equationssetspecificationset (equationsSet, specification, err, error,)
 Sets the equation specification for a coupled diffusion-diffusion equation type of a multi physics equations set class. More...
 
subroutine, public diffusiondiffusion_problemspecificationset (problem, problemSpecification, err, error,)
 Sets the problem specification for a coupled diffusion-diffusion equation type. More...
 
subroutine, public diffusion_diffusion_problem_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,)
 Sets up the coupled diffusion-diffusion equations problem. More...
 
subroutine, public diffusion_diffusion_pre_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,)
 Sets up the diffusion-diffusion problem pre-solve. More...
 
subroutine, public diffusion_diffusion_post_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,)
 Sets up the diffusion-diffusion problem post solve. More...
 
subroutine diffusion_diffusion_post_solve_output_data (CONTROL_LOOP, SOLVER, ERR, ERROR,)
 Sets up the diffuion-diffusion problem post solve output data. More...
 

Detailed Description

This module handles all routines pertaining to diffusion coupled to diffusion.

Function/Subroutine Documentation

subroutine, public diffusion_diffusion_routines::diffusion_diffusion_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 diffusion-diffusion coupled equation.

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

Definition at line 165 of file diffusion_diffusion_routines.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by multi_physics_routines::MULTI_PHYSICS_EQUATIONS_SET_SETUP::multi_physics_equations_set_setup().

subroutine, public diffusion_diffusion_routines::diffusion_diffusion_post_solve ( type(control_loop_type), pointer  CONTROL_LOOP,
type(solver_type), pointer  SOLVER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the diffusion-diffusion problem post solve.

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

Definition at line 535 of file diffusion_diffusion_routines.f90.

References base_routines::enters(), base_routines::exits(), and problem_constants::problem_coupled_source_diffusion_diffusion_subtype.

Referenced by multi_physics_routines::MULTI_PHYSICS_POST_SOLVE::multi_physics_post_solve().

subroutine diffusion_diffusion_routines::diffusion_diffusion_post_solve_output_data ( type(control_loop_type), pointer  CONTROL_LOOP,
type(solver_type), pointer  SOLVER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the diffuion-diffusion problem post solve output data.

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

Definition at line 591 of file diffusion_diffusion_routines.f90.

References base_routines::enters(), base_routines::exits(), and problem_constants::problem_coupled_source_diffusion_diffusion_subtype.

subroutine, public diffusion_diffusion_routines::diffusion_diffusion_pre_solve ( type(control_loop_type), pointer  CONTROL_LOOP,
type(solver_type), pointer  SOLVER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the diffusion-diffusion problem pre-solve.

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

Definition at line 474 of file diffusion_diffusion_routines.f90.

References diffusion_equation_routines::diffusion_presolvegetsourcevalue(), diffusion_equation_routines::diffusion_presolvestorecurrentsolution(), base_routines::enters(), base_routines::exits(), and problem_constants::problem_coupled_source_diffusion_diffusion_subtype.

Referenced by multi_physics_routines::MULTI_PHYSICS_PRE_SOLVE::multi_physics_pre_solve().

subroutine, public diffusion_diffusion_routines::diffusion_diffusion_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 coupled diffusion-diffusion equations problem.

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

Definition at line 292 of file diffusion_diffusion_routines.f90.

References control_loop_routines::control_loop_create_finish(), control_loop_routines::control_loop_create_start(), control_loop_routines::control_loop_node, control_loop_routines::control_loop_solvers_get(), control_loop_routines::control_loop_type_set(), base_routines::enters(), base_routines::exits(), problem_constants::problem_control_time_loop_type, problem_constants::problem_coupled_source_diffusion_diffusion_subtype, problem_constants::problem_setup_control_type, problem_constants::problem_setup_finish_action, problem_constants::problem_setup_initial_type, problem_constants::problem_setup_solver_equations_type, problem_constants::problem_setup_solvers_type, problem_constants::problem_setup_start_action, solver_routines::solver_cmiss_library, solver_routines::solver_dynamic_crank_nicolson_scheme, solver_routines::solver_dynamic_degree_set(), solver_routines::solver_dynamic_first_degree, solver_routines::solver_dynamic_first_order, solver_routines::solver_dynamic_order_set(), solver_routines::solver_dynamic_scheme_set(), solver_routines::solver_dynamic_type, solver_routines::solver_equations_create_finish(), solver_routines::solver_equations_create_start(), problem_constants::solver_equations_first_order_dynamic, problem_constants::solver_equations_linear, solver_routines::solver_equations_linearity_type_set(), solver_routines::solver_equations_sparsity_type_set(), solver_routines::solver_equations_time_dependence_type_set(), solver_routines::solver_library_type_set(), solver_routines::solver_solver_equations_get(), solver_routines::solver_sparse_matrices, solver_routines::solver_type_set(), solver_routines::solvers_create_finish(), solver_routines::solvers_create_start(), solver_routines::solvers_number_set(), and solver_routines::solvers_solver_get().

Referenced by multi_physics_routines::MULTI_PHYSICS_PROBLEM_SETUP::multi_physics_problem_setup().

subroutine, public diffusion_diffusion_routines::diffusiondiffusion_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 
)
subroutine, public diffusion_diffusion_routines::diffusiondiffusion_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 equation specification for a coupled diffusion-diffusion equation type of a multi physics equations set class.

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

Definition at line 215 of file diffusion_diffusion_routines.f90.

References base_routines::enters(), base_routines::errors(), and base_routines::exits().

Referenced by multi_physics_routines::MultiPhysics_EquationsSetSpecificationSet::multiphysics_equationssetspecificationset().

subroutine, public diffusion_diffusion_routines::diffusiondiffusion_finiteelementcalculate ( 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 matrices and RHS for a coupled diffusion-diffusion equation finite element equations set.

Parameters
equations_setA pointer to the equations set to perform the finite element calculations on
[in]element_numberThe element number to calculate
[out]errThe error code
[out]errorThe error string

Definition at line 190 of file diffusion_diffusion_routines.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by multi_physics_routines::MULTI_PHYSICS_FINITE_ELEMENT_CALCULATE::multi_physics_finite_element_calculate().

subroutine, public diffusion_diffusion_routines::diffusiondiffusion_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 coupled diffusion-diffusion equation type.

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

Definition at line 240 of file diffusion_diffusion_routines.f90.

References base_routines::enters(), base_routines::errors(), base_routines::exits(), problem_constants::problem_coupled_source_diffusion_diffusion_subtype, problem_constants::problem_diffusion_diffusion_type, and problem_constants::problem_multi_physics_class.

Referenced by multi_physics_routines::MultiPhysics_ProblemSpecificationSet::multiphysics_problemspecificationset().