OpenCMISS-Iron Internal API Documentation
characteristic_equation_routines Module Reference

This module handles all characteristic equation routines. More...

Functions/Subroutines

subroutine, public characteristic_equationssetsolutionmethodset (equationsSet, solutionMethod, err, error,)
 Sets/changes the solution method for a Characteristic equation type of an fluid mechanics equations set class. More...
 
subroutine, public characteristic_equationssetspecificationset (equationsSet, specification, err, error,)
 Sets the equation specification for a Characteristic type of a fluid mechanics equations set class. More...
 
subroutine, public characteristic_equationssetsetup (equationsSet, equationsSetSetup, err, error,)
 Sets up the Characteristic equations fluid setup. More...
 
subroutine, public characteristic_nodalresidualevaluate (equationsSet, nodeNumber, err, error,)
 Evaluates the residual nodal stiffness matrices and RHS for a characteristic equation nodal equations set. More...
 
subroutine, public characteristic_nodaljacobianevaluate (equationsSet, nodeNumber, err, error,)
 Evaluates the Jacobian nodal matrix for a characteristic equation nodal equations set. More...
 
subroutine, public characteristic_extrapolate (solver, currentTime, timeIncrement, ERR, ERROR,)
 Extrapolate W for branch nodes and boundaries . More...
 
subroutine, public characteristic_primitivetocharacteristic (equationsSet, ERR, ERROR,)
 Calculate Characteristic (W) values based on dependent field values. More...
 

Detailed Description

This module handles all characteristic equation routines.

Function/Subroutine Documentation

subroutine, public characteristic_equation_routines::characteristic_equationssetsetup ( type(equations_set_type), pointer  equationsSet,
type(equations_set_setup_type), intent(inout)  equationsSetSetup,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Sets up the Characteristic equations fluid setup.

Definition at line 222 of file characteristic_equation_routines.f90.

References characteristic_equationssetsolutionmethodset(), base_routines::enters(), equations_routines::equations_create_finish(), equations_routines::equations_create_start(), equations_matrices_routines::equations_jacobian_analytic_calculated, equations_routines::equations_linearity_type_set(), equations_mapping_routines::equations_mapping_create_finish(), equations_mapping_routines::equations_mapping_create_start(), equations_mapping_routines::equations_mapping_rhs_variable_type_set(), equations_matrices_routines::equations_matrices_create_finish(), equations_matrices_routines::equations_matrices_create_start(), equations_matrices_routines::equations_matrices_full_matrices, equations_matrices_routines::equations_matrices_linear_storage_type_set(), equations_matrices_routines::equations_matrices_sparse_matrices, equations_matrices_routines::equations_matrix_nodal_structure, equations_set_constants::equations_nonlinear, equations_set_constants::equations_set_bem_solution_method, equations_set_constants::equations_set_characteristic_subtype, equations_routines::equations_set_equations_get(), equations_set_constants::equations_set_fd_solution_method, equations_set_constants::equations_set_fv_solution_method, equations_set_constants::equations_set_gfem_solution_method, equations_set_constants::equations_set_gfv_solution_method, equations_set_constants::equations_set_nodal_solution_method, equations_set_constants::equations_set_setup_dependent_type, equations_set_constants::equations_set_setup_equations_type, equations_set_constants::equations_set_setup_finish_action, equations_set_constants::equations_set_setup_geometry_type, equations_set_constants::equations_set_setup_independent_type, equations_set_constants::equations_set_setup_initial_type, equations_set_constants::equations_set_setup_materials_type, equations_set_constants::equations_set_setup_start_action, equations_set_constants::equations_static, equations_routines::equations_time_dependence_type_set(), equations_mapping_routines::equationsmapping_linearmatricesnumberset(), equations_mapping_routines::equationsmapping_linearmatricesvariabletypesset(), equations_matrices_routines::equationsmatrices_jacobiantypesset(), equations_matrices_routines::equationsmatrices_linearstructuretypeset(), base_routines::exits(), matrix_vector::matrix_block_storage_type, and matrix_vector::matrix_compressed_row_storage_type.

Referenced by fluid_mechanics_routines::fluid_mechanics_equations_set_setup().

subroutine, public characteristic_equation_routines::characteristic_equationssetsolutionmethodset ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(in)  solutionMethod,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public characteristic_equation_routines::characteristic_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 Characteristic type of a fluid mechanics 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 170 of file characteristic_equation_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_characteristic_equation_type, equations_set_constants::equations_set_characteristic_subtype, equations_set_constants::equations_set_fluid_mechanics_class, base_routines::errors(), and base_routines::exits().

Referenced by fluid_mechanics_routines::fluidmechanics_equationssetspecificationset().

subroutine, public characteristic_equation_routines::characteristic_extrapolate ( type(solver_type), pointer  solver,
real(dp), intent(in)  currentTime,
real(dp), intent(in)  timeIncrement,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Extrapolate W for branch nodes and boundaries .

Definition at line 1321 of file characteristic_equation_routines.f90.

Referenced by navier_stokes_equations_routines::NAVIER_STOKES_PRE_SOLVE::navier_stokes_pre_solve().

subroutine, public characteristic_equation_routines::characteristic_nodaljacobianevaluate ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(in)  nodeNumber,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public characteristic_equation_routines::characteristic_nodalresidualevaluate ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(in)  nodeNumber,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Evaluates the residual nodal stiffness matrices and RHS for a characteristic equation nodal equations set.

Definition at line 853 of file characteristic_equation_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_characteristic_subtype, base_routines::exits(), constants::pi, and constants::zero_tolerance.

Referenced by fluid_mechanics_routines::fluidmechanics_nodalresidualevaluate().

subroutine, public characteristic_equation_routines::characteristic_primitivetocharacteristic ( type(equations_set_type), pointer  equationsSet,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Calculate Characteristic (W) values based on dependent field values.

Parameters
equationssetA pointer the equations set

Definition at line 1572 of file characteristic_equation_routines.f90.