OpenCMISS-Iron Internal API Documentation
fsi_routines Module Reference

This module handles all routines pertaining to finite elasticity coupled with navier stokes for fsi problems. More...

Functions/Subroutines

subroutine, public fsi_equations_set_solution_method_set (EQUATIONS_SET, SOLUTION_METHOD, Err, Error,)
 Sets/changes the solution method for a finite elasticity navier stokes equation type of a multi physics equations set class. More...
 
subroutine, public fsi_equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP, Err, Error,)
 Sets up the finite elasticity navier stokes equation. More...
 
subroutine, public fsi_finite_element_calculate (EQUATIONS_SET, ELEMENT_NUMBER, Err, Error,)
 Calculates the element stiffness matrices and RHS for a finite elasticity navier stokes equation finite element equations set. More...
 
subroutine, public fsi_equationssetspecificationset (equationsSet, specification, Err, Error,)
 Sets/changes the equation subtype for a finite elasticity navier stokes equation type of a multi physics equations set class. More...
 
subroutine, public fsi_problemspecificationset (problem, problemSpecification, err, error,)
 Sets the problem specification for a finite elasticity Navier-Stokes equation type. More...
 
subroutine, public fsi_problem_setup (PROBLEM, PROBLEM_SETUP, Err, Error,)
 Sets up the finite elasticity navier stokes equations problem. More...
 
subroutine, public fsi_pre_solve (ControlLoop, Solver, Err, Error,)
 Sets up the finite elasticity navier stokes problem pre-solve. More...
 
subroutine, public fsi_post_solve (ControlLoop, Solver, Err, Error,)
 Sets up the finite elasticity navier stokes problem post solve. More...
 
subroutine, public fsi_control_loop_pre_loop (ControlLoop, Err, Error,)
 Runs before each control loop iteration. More...
 
subroutine, public fsi_control_loop_post_loop (ControlLoop, Err, Error,)
 Runs after each control loop iteration. Updates interface and fluid geometric fields and exports fields. More...
 

Detailed Description

This module handles all routines pertaining to finite elasticity coupled with navier stokes for fsi problems.

Function/Subroutine Documentation

subroutine, public fsi_routines::fsi_control_loop_pre_loop ( type(control_loop_type), pointer  ControlLoop,
integer(intg), intent(out)  Err,
type(varying_string), intent(out)  Error 
)

Runs before each control loop iteration.

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

Definition at line 601 of file fsi_routines.f90.

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

subroutine, public fsi_routines::fsi_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 finite elasticity navier stokes 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 154 of file fsi_routines.f90.

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

subroutine, public fsi_routines::fsi_equations_set_solution_method_set ( 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 finite elasticity navier stokes equation type of a multi physics equations 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 96 of file fsi_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_bem_solution_method, equations_set_constants::equations_set_fd_solution_method, equations_set_constants::equations_set_fem_solution_method, equations_set_constants::equations_set_finite_elasticity_navier_stokes_ale_subtype, equations_set_constants::equations_set_fv_solution_method, equations_set_constants::equations_set_gfem_solution_method, equations_set_constants::equations_set_gfv_solution_method, and base_routines::exits().

subroutine, public fsi_routines::fsi_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/changes the equation subtype for a finite elasticity navier stokes 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 201 of file fsi_routines.f90.

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

subroutine, public fsi_routines::fsi_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 matrices and RHS for a finite elasticity navier stokes 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 178 of file fsi_routines.f90.

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

subroutine, public fsi_routines::fsi_post_solve ( type(control_loop_type), pointer  ControlLoop,
type(solver_type), pointer  Solver,
integer(intg), intent(out)  Err,
type(varying_string), intent(out)  Error 
)

Sets up the finite elasticity navier stokes problem post solve.

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

Definition at line 513 of file fsi_routines.f90.

References base_routines::enters(), base_routines::exits(), base_routines::general_output_type, problem_constants::problem_finite_elasticity_navier_stokes_ale_subtype, solver_routines::solver_dynamic_type, solver_routines::solver_linear_type, and solver_routines::solvers_solver_get().

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

subroutine, public fsi_routines::fsi_pre_solve ( type(control_loop_type), pointer  ControlLoop,
type(solver_type), pointer  Solver,
integer(intg), intent(out)  Err,
type(varying_string), intent(out)  Error 
)

Sets up the finite elasticity navier stokes problem pre-solve.

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

Definition at line 455 of file fsi_routines.f90.

References base_routines::enters(), base_routines::exits(), base_routines::general_output_type, problem_constants::problem_control_time_loop_type, and problem_constants::problem_finite_elasticity_navier_stokes_ale_subtype.

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

subroutine, public fsi_routines::fsi_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 finite elasticity navier stokes 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 280 of file fsi_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_output_type_set(), control_loop_routines::control_loop_progress_output, 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_finite_elasticity_navier_stokes_ale_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_linearity_type_set(), solver_routines::solver_dynamic_nonlinear, 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(), problem_constants::solver_equations_nonlinear, solver_routines::solver_equations_sparsity_type_set(), problem_constants::solver_equations_static, solver_routines::solver_equations_time_dependence_type_set(), solver_routines::solver_library_type_set(), solver_routines::solver_linear_type, solver_routines::solver_petsc_library, 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 fsi_routines::fsi_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 finite elasticity Navier-Stokes equation type.

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 227 of file fsi_routines.f90.

References base_routines::enters(), base_routines::errors(), base_routines::exits(), problem_constants::problem_finite_elasticity_navier_stokes_ale_subtype, problem_constants::problem_finite_elasticity_navier_stokes_type, and problem_constants::problem_multi_physics_class.

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