OpenCMISS-Iron Internal API Documentation
solver_mapping_routines Module Reference

This module handles all solver mapping routines. More...

Functions/Subroutines

subroutine solver_mapping_calculate (SOLVER_MAPPING, ERR, ERROR,)
 Calculates the solver mappings. More...
 
subroutine, public solver_mapping_create_finish (SOLVER_MAPPING, ERR, ERROR,)
 Finishes the process of creating a solver mapping. More...
 
subroutine, public solver_mapping_create_start (SOLVER_EQUATIONS, SOLVER_MAPPING, ERR, ERROR,)
 Finishes the process of creating a solver mapping for a problem solver. More...
 
subroutine solver_mapping_create_values_cache_finalise (CREATE_VALUES_CACHE, ERR, ERROR,)
 Finalises a solver mapping create values cache and deallocates all memory. More...
 
subroutine solvermapping_createvaluescacheinitialise (SOLVER_MAPPING, ERR, ERROR,)
 Initialises a solver mapping create values cache. More...
 
subroutine solvermapping_createvaluescacheeqnvarlistadd (SOLVER_MAPPING, solver_matrix_idx, equations_set_idx, variable_type, ERR, ERROR,)
 Adds a variable type from an equations set dependent field to the list of variables for a particular solver matrix of a solver mapping. More...
 
subroutine solvermapping_createvaluescacheinterfvarlistadd (SOLVER_MAPPING, solver_matrix_idx, interface_condition_idx, variable_type, ERR, ERROR,)
 Adds a variable type from an interface condition Lagrange field to the list of variables for a particular solver matrix of a solver mapping. More...
 
subroutine, public solver_mapping_destroy (SOLVER_MAPPING, ERR, ERROR,)
 Destroy a solver mapping. More...
 
subroutine solvermapping_equatscoltosolcolsmapfinalise (EQUATIONS_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Finalises a equations column to solver columns map and deallocates all memory. More...
 
subroutine solvermapping_equatscoltosolcolsmapinitialise (EQUATIONS_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Initialises an equations column to solver columns map. More...
 
subroutine, public solvermapping_equatsvarstosolvermatrixset (SOLVER_MAPPING, SOLVER_MATRIX, EQUATIONS_SET_INDEX, VARIABLE_TYPES, ERR, ERROR,)
 Sets/changes the mapping of global variables to a solver matrix for the solver mapping. More...
 
subroutine solvermapping_equatsrowtosolrowsmapfinalise (EQUATIONS_ROW_SOLVER_ROWS_MAP, ERR, ERROR,)
 Finalises a equations row to solver rows map and deallocates all memory. More...
 
subroutine solvermapping_equatsrowtosolrowsmapinitialise (EQUATIONS_ROW_SOLVER_ROWS_MAP, ERR, ERROR,)
 Initialises an equations row to solver rows map. More...
 
subroutine, public solver_mapping_equations_set_add (SOLVER_MAPPING, EQUATIONS_SET, EQUATIONS_SET_INDEX, ERR, ERROR,)
 Adds an equations set to a solver mapping. More...
 
subroutine solvermapping_equationssettosolvermapfinalise (EQUATIONS_SET_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a equations set to solver map and deallocates all memory. More...
 
subroutine solvermapping_equationssettosolvermapinitialise (EQUATIONS_SET_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises a equations set to solver map. More...
 
subroutine solvermapping_equationstosolvermapsfinalise (EQUATIONS_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a equations set to solver matrix map and deallocates all memory. More...
 
subroutine solvermapping_equationstosolvermapsinitialise (EQUATIONS_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises an equations to solver maps. More...
 
subroutine solvermapping_equationstosolverinterfacefinalise (EQUATIONS_TO_SOLVER_INTERFACE_MAP, ERR, ERROR,)
 Finalises a equations set to solver matrix map and deallocates all memory. More...
 
subroutine solvermapping_equationstosolverinterfaceinitialise (EQUATIONS_TO_SOLVER_INTERFACE_MAP, ERR, ERROR,)
 Initialises a equations set to solver matrix interface map. More...
 
subroutine solvermapping_equatstosolmatmapsemfinalise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_EM, ERR, ERROR,)
 Finalises a equations set to solver matrix map em and deallocates all memory. More...
 
subroutine solvermapping_equatstosolmatmapseminitialise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_EM, ERR, ERROR,)
 Initialises an equations to solver matrix maps em. More...
 
subroutine solvermapping_equatstosolmatmapsjmfinalise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_JM, ERR, ERROR,)
 Finalises a equations set to solver matrix map jm and deallocates all memory. More...
 
subroutine solvermapping_equatstosolmatmapssmfinalise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Finalises a equations set to solver matrix map sm and deallocates all memory. More...
 
subroutine solvermapping_equatstosolmatmapssminitialise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Initialises an equations to solver matrix maps sm. More...
 
subroutine solver_mapping_finalise (SOLVER_MAPPING, ERR, ERROR,)
 Finalises the solver mapping and deallocates all memory. More...
 
subroutine solver_mapping_initialise (SOLVER_EQUATIONS, ERR, ERROR,)
 Initialises the solver mapping and deallocates all memory. More...
 
subroutine, public solver_mapping_interface_condition_add (SOLVER_MAPPING, INTERFACE_CONDITION, INTERFACE_CONDITION_INDEX, ERR, ERROR,)
 Adds an interface condition to a solver mapping. More...
 
subroutine solvermapping_interfconditiontosolvermapfinalise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises an interface condition to solver map and deallocates all memory. More...
 
subroutine solvermapping_interfconditiontosolvermapinitialise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises an interface condition to solver map. More...
 
subroutine solvermapping_interfacetosolvermapfinalise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a interface condition to solver map and deallocates all memory. More...
 
subroutine solvermapping_interfacetosolvermapinitialise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises an interface condition to solver map. More...
 
subroutine solvermapping_interfacetosolvermapsfinalise (INTERFACE_TO_SOLVER_MAPS, ERR, ERROR,)
 Finalises an interface to solver matrix maps and deallocates all memory. More...
 
subroutine solvermapping_interfacetosolvermapsinitialise (INTERFACE_TO_SOLVER_MAPS, ERR, ERROR,)
 Initialises an interface to solver maps. More...
 
subroutine solvermapping_interfacetosolverequationsfinalise (INTERFACE_TO_SOLVER_EQUATIONS_MAPS, ERR, ERROR,)
 Finalises an interface to solver matrix equations map and deallocates all memory. More...
 
subroutine solvermapping_interfacetosolverequationsinitialise (INTERFACE_TO_SOLVER_EQUATIONS_MAPS, ERR, ERROR,)
 Initialises an interface to solver matrix equations map. More...
 
subroutine solvermapping_interfcoltosolrowsmapfinalise (INTERFACE_COLUMN_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Finalises a interface column to solver row map and deallocates all memory. More...
 
subroutine solvermapping_interfcoltosolrowsmapinitialise (INTERFACE_COLUMN_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Initialises am interface column to solver row map. More...
 
subroutine solvermapping_interfrowtosolrowsmapfinalise (INTERFACE_ROW_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Finalises a interface row to solver row map and deallocates all memory. More...
 
subroutine solvermapping_interfrowtosolrowsmapinitialise (INTERFACE_ROW_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Initialises am interface row to solver row map. More...
 
subroutine solvermapping_interftosolmatmapsimfinalise (INTERFACE_TO_SOLVER_MATRIX_MAPS_IM, ERR, ERROR,)
 Finalises an interface to solver matrix map im and deallocates all memory. More...
 
subroutine solvermapping_interftosolmatmapsiminitialise (INTERFACE_TO_SOLVER_MATRIX_MAPS_IM, ERR, ERROR,)
 Initialises an interface to solver matrix maps im. More...
 
subroutine solvermapping_interftosolmatmapssmfinalise (INTERFACE_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Finalises an interface to solver matrix map sm and deallocates all memory. More...
 
subroutine solvermapping_interftosolmatmapssminitialise (INTERFACE_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Initialises an interface to solver matrix maps sm. More...
 
subroutine solvermapping_jaccoltosolcolsmapfinalise (JACOBIAN_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Finalises a Jacobian column to solver columns map and deallocates all memory. More...
 
subroutine solvermapping_jaccoltosolcolsmapinitialise (JACOBIAN_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Initialises an Jacobian column to solver columns map. More...
 
subroutine solvermapping_jacobiantosolvermapfinalise (JACOBIAN_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a equations set to solver matrix map and deallocates all memory. More...
 
subroutine solvermapping_jacobiantosolvermapinitialise (JACOBIAN_TO_SOLVER_MATRIX_MAP, ERR, ERROR,)
 Initialises a Jacobian to solver maps. More...
 
subroutine solvermapping_solvercoltodequationsmapfinalise (SOLVER_COL_TO_DYNAMIC_EQUATIONS_MAP, ERR, ERROR,)
 Finalises the solver column to dynamic equations map and deallocates all memory. More...
 
subroutine solvermapping_solvercoltodequationsmapinitialise (SOLVER_COL_TO_DYNAMIC_EQUATIONS_MAP, ERR, ERROR,)
 Initialises the solver column to dynamic equations mapping and deallocates all memory. More...
 
subroutine solvermapping_solvercoltosequationsmapfinalise (SOLVER_COL_TO_STATIC_EQUATIONS_MAP, ERR, ERROR,)
 Finalises the solver column to static equations map and deallocates all memory. More...
 
subroutine solvermapping_solvercoltosequationsmapinitialise (SOLVER_COL_TO_STATIC_EQUATIONS_MAP, ERR, ERROR,)
 Initialises the solver column to static equations mapping and deallocates all memory. More...
 
subroutine solvermapping_solcoltoequatssetmapfinalise (SOLVER_COL_TO_EQUATIONS_SET_MAP, ERR, ERROR,)
 Finalises the solver column to equations set map and deallocates all memory. More...
 
subroutine solvermapping_solcoltoequatssetmapinitialise (SOLVER_COL_TO_EQUATIONS_SET_MAP, ERR, ERROR,)
 Initialises the solver column to equations set mapping and deallocates all memory. More...
 
subroutine solvermapping_solcoltoequationsmapsfinalise (SOLVER_COL_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Finalises the solver column to equations map and deallocates all memory. More...
 
subroutine solvermapping_solcoltoequationsmapsinitialise (SOLVER_COL_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Initialises the solver column to equations mapping and deallocates all memory. More...
 
subroutine solvermapping_solcoltointerfmapfinalise (SOLVER_COL_TO_INTERFACE_MAP, ERR, ERROR,)
 Finalises the solver column to interface map and deallocates all memory. More...
 
subroutine solvermapping_solcoltointerfmapinitialise (SOLVER_COL_TO_INTERFACE_MAP, ERR, ERROR,)
 Initialises the solver column to interface mapping. More...
 
subroutine solvermapping_solcoltointerfequatsmapfinalise (SOLVER_COL_TO_INTERFACE_EQUATIONS_MAP, ERR, ERROR,)
 Finalises the solver column to interface equations map and deallocates all memory. More...
 
subroutine solvermapping_solcoltointerfequatsmapinitialise (SOLVER_COL_TO_INTERFACE_EQUATIONS_MAP, ERR, ERROR,)
 Initialises the solver column to interface equations mapping. More...
 
subroutine solvermapping_solverdoftovariablemapfinalise (SOLVER_DOF_TO_VARIABLE_MAP, ERR, ERROR,)
 Finalises the solver dof to variable mapping and deallocates all memory. More...
 
subroutine solvermapping_solverdoftovariablemapinitialise (SOLVER_DOF_TO_VARIABLE_MAP, ERR, ERROR,)
 Initialises the solver dof to variable mapping. More...
 
subroutine, public solver_mapping_solver_matrices_number_set (SOLVER_MAPPING, NUMBER_OF_SOLVER_MATRICES, ERR, ERROR,)
 Sets/changes the number of solver matrices for the solver mapping. More...
 
subroutine solvermapping_solrowtoequationsmapsfinalise (SOLVER_ROW_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Finalises a solver row to equations map and deallocates all memory. More...
 
subroutine solvermapping_solrowtoequationsmapsinitialise (SOLVER_ROW_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Initialises a solver row to equations map. More...
 
subroutine solver_mapping_variable_finalise (SOLVER_MAPPING_VARIABLE, ERR, ERROR,)
 Finalises the solver mapping variable and deallocates all memory. More...
 
subroutine solver_mapping_variable_initialise (SOLVER_MAPPING_VARIABLE, ERR, ERROR,)
 Initialises the solver mapping and deallocates all memory. More...
 
subroutine solver_mapping_variables_finalise (SOLVER_MAPPING_VARIABLES, ERR, ERROR,)
 Finalises the solver mapping variables and deallocates all memory. More...
 
subroutine solver_mapping_variables_initialise (SOLVER_MAPPING_VARIABLES, ERR, ERROR,)
 Initialises the solver mapping variables and deallocates all memory. More...
 
subroutine solvermapping_variabletosolvercolmapfinalise (VARIABLE_TO_SOLVER_COL_MAP, ERR, ERROR,)
 Finalises a variable to solver column map and deallocates all memory. More...
 
subroutine solvermapping_variabletosolvercolmapinitialise (VARIABLE_TO_SOLVER_COL_MAP, ERR, ERROR,)
 Initialises a variable to solver column map. More...
 
subroutine solverdofcouplings_addcoupling (solverDofCouplings, coupling, couplingIndex, err, error,)
 Add a new DOF coupling to the list of global solver couplings. More...
 
subroutine solverdofcouplings_finalise (solverDofCouplings, err, error,)
 Initialise the list of solver row or column couplings. More...
 
subroutine solverdofcouplings_initialise (solverDofCouplings, err, error,)
 Initialise the list of solver row or column couplings. More...
 

Variables

integer(intg), parameter, public solver_mapping_equations_dynamic_matrix =1
 The equations matrix in the solver mapping is a dynamic equations matrix. More...
 
integer(intg), parameter, public solver_mapping_equations_linear_matrix =2
 The equations matrix in the solver mapping is a linear equations matrix. More...
 
integer(intg), parameter solver_mapping_equations_nonlinear_matrix =3
 The equations matrix in the solver mapping is a nonlinear equations (Jacobian) matrix. More...
 
integer(intg), parameter, public solver_mapping_equations_equations_set =1
 The equations in the solver mapping is from an equations set. More...
 
integer(intg), parameter, public solver_mapping_equations_interface_condition =2
 The equations in the solver mapping is from an interface condition. More...
 
integer(intg), parameter solver_mapping_equations_interface_transpose =3
 The equations in the solver mapping is from a transposed interface condition. More...
 

Detailed Description

This module handles all solver mapping routines.

Function/Subroutine Documentation

subroutine solver_mapping_routines::solver_mapping_calculate ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Calculates the solver mappings.

Parameters
solver_mappingA pointer to the solver mapping to calcualte
[out]errThe error code
[out]errorThe error string

Definition at line 120 of file solver_mapping_routines.f90.

References boundary_conditions_routines::boundary_condition_dof_constrained, boundary_conditions_routines::boundary_condition_dof_free, boundary_conditions_routines::boundary_conditions_variable_get(), comp_environment::computational_environment, base_routines::diagnostic_output_type, base_routines::diagnostics1, base_routines::diagnostics2, domain_mappings::domain_local_ghost, domain_mappings::domain_local_internal, domain_mappings::domain_mappings_local_from_global_calculate(), domain_mappings::domain_mappings_mapping_global_initialise(), domain_mappings::domain_mappings_mapping_initialise(), base_routines::enters(), base_routines::exits(), interface_conditions_constants::interface_condition_augmented_lagrange_method, interface_conditions_constants::interface_condition_lagrange_multipliers_method, interface_conditions_constants::interface_condition_penalty_method, interface_conditions_constants::interface_condition_point_to_point_method, kinds::intg, lists::list_create_finish(), lists::list_create_start(), lists::list_data_dimension_set(), lists::list_data_type_set(), lists::list_destroy(), lists::list_initial_size_set(), lists::list_intg_type, lists::list_key_dimension_set(), lists::list_remove_duplicates(), kinds::ptr, solver_mapping_equations_dynamic_matrix, solver_mapping_equations_equations_set, solver_mapping_equations_interface_condition, solver_mapping_equations_interface_transpose, solver_mapping_equations_linear_matrix, solver_mapping_equations_nonlinear_matrix, solver_mapping_variable_initialise(), solver_mapping_variables_initialise(), solverdofcouplings_addcoupling(), solverdofcouplings_finalise(), solverdofcouplings_initialise(), solvermapping_equationssettosolvermapinitialise(), solvermapping_equationstosolverinterfaceinitialise(), solvermapping_equationstosolvermapsinitialise(), solvermapping_equatsrowtosolrowsmapinitialise(), solvermapping_equatstosolmatmapseminitialise(), solvermapping_equatstosolmatmapssminitialise(), solvermapping_interfacetosolverequationsinitialise(), solvermapping_interfacetosolvermapinitialise(), solvermapping_interfacetosolvermapsinitialise(), solvermapping_interfcoltosolrowsmapinitialise(), solvermapping_interfrowtosolrowsmapinitialise(), solvermapping_interftosolmatmapsiminitialise(), solvermapping_interftosolmatmapssminitialise(), solvermapping_jacobiantosolvermapinitialise(), solvermapping_solcoltoequationsmapsinitialise(), solvermapping_solcoltoequatssetmapinitialise(), solvermapping_solcoltointerfmapinitialise(), solvermapping_solrowtoequationsmapsinitialise(), and solvermapping_solverdoftovariablemapinitialise().

Referenced by solver_mapping_create_finish().

subroutine, public solver_mapping_routines::solver_mapping_create_finish ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Finishes the process of creating a solver mapping.

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

Definition at line 3775 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::exits(), solver_mapping_calculate(), solver_mapping_create_values_cache_finalise(), and solver_mapping_finalise().

subroutine, public solver_mapping_routines::solver_mapping_create_start ( type(solver_equations_type), pointer  SOLVER_EQUATIONS,
type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Finishes the process of creating a solver mapping for a problem solver.

Parameters
solver_equationsA pointer to the solver equations to create the solver mapping on.
solver_mappingOn return, a pointer to the solver mapping. Must not be associated on entry
[out]errThe error code
[out]errorThe error string

Definition at line 3815 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solver_mapping_create_values_cache_finalise ( type(solver_mapping_create_values_cache_type), pointer  CREATE_VALUES_CACHE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a solver mapping create values cache and deallocates all memory.

Parameters
create_values_cacheA pointer to the create values cache
[out]errThe error code
[out]errorThe error string

Definition at line 3853 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_create_finish(), solver_mapping_finalise(), and solvermapping_createvaluescacheinitialise().

subroutine, public solver_mapping_routines::solver_mapping_destroy ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Destroy a solver mapping.

Parameters
solver_mappingA pointer the solver mapping to destroy
[out]errThe error code
[out]errorThe error string

Definition at line 4199 of file solver_mapping_routines.f90.

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

subroutine, public solver_mapping_routines::solver_mapping_equations_set_add ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
type(equations_set_type), pointer  EQUATIONS_SET,
integer(intg), intent(out)  EQUATIONS_SET_INDEX,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine solver_mapping_routines::solver_mapping_finalise ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private
subroutine solver_mapping_routines::solver_mapping_initialise ( type(solver_equations_type), pointer  SOLVER_EQUATIONS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver mapping and deallocates all memory.

Parameters
solver_equationsA pointer to the solver equations to initialise the solver mapping on.
[out]errThe error code
[out]errorThe error string

Definition at line 5205 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_create_start().

subroutine, public solver_mapping_routines::solver_mapping_interface_condition_add ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
type(interface_condition_type), pointer  INTERFACE_CONDITION,
integer(intg), intent(out)  INTERFACE_CONDITION_INDEX,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Adds an interface condition to a solver mapping.

Parameters
solver_mappingA pointer the solver mapping to add the interface condition to
interface_conditionA pointer to the interface condition to add
[out]interface_condition_indexOn exit, the index of the interface condition in the solver mapping
[out]errThe error code
[out]errorThe error string

Definition at line 5250 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::exits(), interface_conditions_constants::interface_condition_augmented_lagrange_method, interface_conditions_constants::interface_condition_lagrange_multipliers_method, interface_conditions_constants::interface_condition_penalty_method, interface_conditions_constants::interface_condition_point_to_point_method, kinds::ptr, and solvermapping_createvaluescacheinterfvarlistadd().

subroutine, public solver_mapping_routines::solver_mapping_solver_matrices_number_set ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(in)  NUMBER_OF_SOLVER_MATRICES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets/changes the number of solver matrices for the solver mapping.

Parameters
solver_mappingA pointer to the solver mapping
[in]number_of_solver_matricesThe number of solver matrices for the solver.
[out]errThe error code
[out]errorThe error string

Definition at line 6513 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solver_mapping_variable_finalise ( type(solver_mapping_variable_type)  SOLVER_MAPPING_VARIABLE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver mapping variable and deallocates all memory.

Parameters
solver_mapping_variableThe solver mapping variable to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6661 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_variables_finalise().

subroutine solver_mapping_routines::solver_mapping_variable_initialise ( type(solver_mapping_variable_type)  SOLVER_MAPPING_VARIABLE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver mapping and deallocates all memory.

Parameters
solver_mapping_variableThe solver mapping variable to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6688 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solver_mapping_variables_finalise ( type(solver_mapping_variables_type)  SOLVER_MAPPING_VARIABLES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver mapping variables and deallocates all memory.

Parameters
solver_mapping_variablesThe solver mapping variables to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6713 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_finalise().

subroutine solver_mapping_routines::solver_mapping_variables_initialise ( type(solver_mapping_variables_type)  SOLVER_MAPPING_VARIABLES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver mapping variables and deallocates all memory.

Parameters
solver_mapping_variablesThe solver mapping variables to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6740 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solverdofcouplings_addcoupling ( type(solvermappingdofcouplingstype), intent(inout)  solverDofCouplings,
type(boundaryconditionscoupleddofstype), intent(in), pointer  coupling,
integer(intg), intent(out)  couplingIndex,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
private

Add a new DOF coupling to the list of global solver couplings.

Parameters
[in,out]solverdofcouplingsThe solver row or column couplings
[in]couplingThe new DOF boundary condition coupling to add to the list
[out]couplingindexOn return, the index of the coupling in the solver dof couplings
[out]errThe error code
[out]errorThe error string

Definition at line 6815 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solverdofcouplings_finalise ( type(solvermappingdofcouplingstype), intent(inout)  solverDofCouplings,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
private

Initialise the list of solver row or column couplings.

Parameters
[in,out]solverdofcouplingsThe solver row or column couplings to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6863 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solverdofcouplings_initialise ( type(solvermappingdofcouplingstype), intent(inout)  solverDofCouplings,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
private

Initialise the list of solver row or column couplings.

Parameters
[in,out]solverdofcouplingsThe solver row or column couplings to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6892 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_createvaluescacheeqnvarlistadd ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(in)  solver_matrix_idx,
integer(intg), intent(in)  equations_set_idx,
integer(intg), intent(in)  variable_type,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds a variable type from an equations set dependent field to the list of variables for a particular solver matrix of a solver mapping.

Parameters
solver_mappingA pointer the solver mapping to add to the var list for.
[in]solver_matrix_idxThe solver matrix index of the variable list
[in]equations_set_idxThe equations set index of the variable to add
[in]variable_typeThe variable type to add
[out]errThe error code
[out]errorThe error string

Definition at line 4001 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_equations_set_add().

subroutine solver_mapping_routines::solvermapping_createvaluescacheinitialise ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises a solver mapping create values cache.

Parameters
solver_mappingA pointer to the create values cache
[out]errThe error code
[out]errorThe error string

Definition at line 3906 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::exits(), lists::list_create_finish(), lists::list_create_start(), lists::list_data_dimension_set(), lists::list_data_type_set(), lists::list_intg_type, lists::list_key_dimension_set(), and solver_mapping_create_values_cache_finalise().

Referenced by solver_mapping_initialise().

subroutine solver_mapping_routines::solvermapping_createvaluescacheinterfvarlistadd ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(in)  solver_matrix_idx,
integer(intg), intent(in)  interface_condition_idx,
integer(intg), intent(in)  variable_type,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds a variable type from an interface condition Lagrange field to the list of variables for a particular solver matrix of a solver mapping.

Parameters
solver_mappingA pointer the solver mapping to add to the var list for.
[in]solver_matrix_idxThe solver matrix index of the variable list
[in]interface_condition_idxThe interface condition index of the variable to add
[in]variable_typeThe variable type to add
[out]errThe error code
[out]errorThe error string

Definition at line 4084 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::errors(), base_routines::exits(), interface_conditions_constants::interface_condition_augmented_lagrange_method, interface_conditions_constants::interface_condition_lagrange_multipliers_method, interface_conditions_constants::interface_condition_penalty_method, interface_conditions_constants::interface_condition_point_to_point_method, and lists::list_number_of_items_get().

Referenced by solver_mapping_interface_condition_add().

subroutine solver_mapping_routines::solvermapping_equationssettosolvermapfinalise ( type(equations_set_to_solver_map_type)  EQUATIONS_SET_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations set to solver map and deallocates all memory.

Parameters
equations_set_to_solver_mapThe equations set to solver map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 4765 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::errors(), base_routines::exits(), solvermapping_equationstosolverinterfacefinalise(), solvermapping_equatsrowtosolrowsmapfinalise(), solvermapping_equatstosolmatmapsemfinalise(), solvermapping_equatstosolmatmapsjmfinalise(), and solvermapping_equatstosolmatmapssmfinalise().

Referenced by solver_mapping_finalise().

subroutine solver_mapping_routines::solvermapping_equationssettosolvermapinitialise ( type(equations_set_to_solver_map_type)  EQUATIONS_SET_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises a equations set to solver map.

Parameters
equations_set_to_solver_mapThe equations set to solver map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 4823 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_equationstosolverinterfacefinalise ( type(equations_to_solver_matrix_maps_interface_type)  EQUATIONS_TO_SOLVER_INTERFACE_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations set to solver matrix map and deallocates all memory.

Parameters
equations_to_solver_interface_mapThe equations set to solver map interface to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 4917 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equationssettosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_equationstosolverinterfaceinitialise ( type(equations_to_solver_matrix_maps_interface_type)  EQUATIONS_TO_SOLVER_INTERFACE_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises a equations set to solver matrix interface map.

Parameters
equations_to_solver_interface_mapThe equations set to solver map interface to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 4944 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_equationstosolvermapsfinalise ( type(equations_to_solver_maps_type), pointer  EQUATIONS_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations set to solver matrix map and deallocates all memory.

Parameters
equations_to_solver_mapThe equations set to solver map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 4851 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equatstosolmatmapsemfinalise(), and solvermapping_equatstosolmatmapssmfinalise().

subroutine solver_mapping_routines::solvermapping_equationstosolvermapsinitialise ( type(equations_to_solver_maps_type), pointer  EQUATIONS_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an equations to solver maps.

Parameters
equations_to_solver_mapThe equations to solver maps to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 4884 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_equatscoltosolcolsmapfinalise ( type(equations_col_to_solver_cols_map_type)  EQUATIONS_COL_TO_SOLVER_COLS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations column to solver columns map and deallocates all memory.

Parameters
equations_col_to_solver_cols_mapThe equations col to solver cols map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 4227 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equationstosolvermapsfinalise(), solvermapping_interfacetosolvermapsfinalise(), and solvermapping_interftosolmatmapssmfinalise().

subroutine solver_mapping_routines::solvermapping_equatscoltosolcolsmapinitialise ( type(equations_col_to_solver_cols_map_type)  EQUATIONS_COL_TO_SOLVER_COLS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an equations column to solver columns map.

Parameters
equations_col_to_solver_cols_mapThe equations column to solver columns map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 4254 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_equatsrowtosolrowsmapfinalise ( type(equations_row_to_solver_rows_map_type)  EQUATIONS_ROW_SOLVER_ROWS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations row to solver rows map and deallocates all memory.

Parameters
equations_row_solver_rows_mapThe equations row to solver rows map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 4390 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equationssettosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_equatsrowtosolrowsmapinitialise ( type(equations_row_to_solver_rows_map_type)  EQUATIONS_ROW_SOLVER_ROWS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an equations row to solver rows map.

Parameters
equations_row_solver_rows_mapThe equations row to solver rows map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 4417 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_equatstosolmatmapsemfinalise ( type(equations_to_solver_matrix_maps_em_type)  EQUATIONS_TO_SOLVER_MATRIX_MAPS_EM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations set to solver matrix map em and deallocates all memory.

Parameters
equations_to_solver_matrix_maps_emThe equations set to solver matrix maps em to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 4971 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equationssettosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_equatstosolmatmapseminitialise ( type(equations_to_solver_matrix_maps_em_type)  EQUATIONS_TO_SOLVER_MATRIX_MAPS_EM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an equations to solver matrix maps em.

Parameters
equations_to_solver_matrix_maps_emThe equations to solver matrix maps em to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5002 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_equatstosolmatmapsjmfinalise ( type(jacobian_to_solver_map_ptr_type), dimension(:), intent(in), allocatable  EQUATIONS_TO_SOLVER_MATRIX_MAPS_JM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations set to solver matrix map jm and deallocates all memory.

Parameters
[in]equations_to_solver_matrix_maps_jmThe equations set to solver matrix maps jm to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5028 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equationssettosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_equatstosolmatmapssmfinalise ( type(equations_to_solver_matrix_maps_sm_type)  EQUATIONS_TO_SOLVER_MATRIX_MAPS_SM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations set to solver matrix map sm and deallocates all memory.

Parameters
equations_to_solver_matrix_maps_smThe equations set to solver matrix maps sm to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5058 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::exits(), solvermapping_equationstosolvermapsfinalise(), solvermapping_jacobiantosolvermapfinalise(), and solvermapping_variabletosolvercolmapfinalise().

Referenced by solvermapping_equationssettosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_equatstosolmatmapssminitialise ( type(equations_to_solver_matrix_maps_sm_type)  EQUATIONS_TO_SOLVER_MATRIX_MAPS_SM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an equations to solver matrix maps sm.

Parameters
equations_to_solver_matrix_maps_smThe equations to solver matrix maps sm to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5112 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine, public solver_mapping_routines::solvermapping_equatsvarstosolvermatrixset ( type(solver_mapping_type), pointer  SOLVER_MAPPING,
integer(intg), intent(in)  SOLVER_MATRIX,
integer(intg), intent(in)  EQUATIONS_SET_INDEX,
integer(intg), dimension(:), intent(in)  VARIABLE_TYPES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets/changes the mapping of global variables to a solver matrix for the solver mapping.

Parameters
solver_mappingA pointer to the solver mapping
[in]solver_matrixThe solver matrix number to set the equations variables for
[in]equations_set_indexThe equations set index in the solver mapping to specify the variable types for
[in]variable_typesThe variable types to map to the solver matrix
[out]errThe error code
[out]errorThe error string

Definition at line 4280 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_interfacetosolverequationsfinalise ( type(interface_to_solver_matrix_maps_equations_type)  INTERFACE_TO_SOLVER_EQUATIONS_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises an interface to solver matrix equations map and deallocates all memory.

Parameters
interface_to_solver_equations_mapsThe interface to solver equations map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5667 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_interfacetosolvermapfinalise(), and solvermapping_interfconditiontosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_interfacetosolverequationsinitialise ( type(interface_to_solver_matrix_maps_equations_type)  INTERFACE_TO_SOLVER_EQUATIONS_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an interface to solver matrix equations map.

Parameters
interface_to_solver_equations_mapsThe interface to solver equations map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5694 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_interfacetosolvermapfinalise ( type(interface_condition_to_solver_map_type), pointer  INTERFACE_CONDITION_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a interface condition to solver map and deallocates all memory.

Parameters
interface_condition_to_solver_mapThe equations set to solver map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5533 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_interfacetosolvermapinitialise ( type(interface_condition_to_solver_map_type)  INTERFACE_CONDITION_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an interface condition to solver map.

Parameters
interface_condition_to_solver_mapThe interface condition to solver map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5574 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_interfacetosolvermapsfinalise ( type(interface_to_solver_maps_type), pointer  INTERFACE_TO_SOLVER_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises an interface to solver matrix maps and deallocates all memory.

Parameters
interface_to_solver_mapsThe interface to solver maps to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5602 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_interftosolmatmapsimfinalise(), and solvermapping_interftosolmatmapssmfinalise().

subroutine solver_mapping_routines::solvermapping_interfacetosolvermapsinitialise ( type(interface_to_solver_maps_type), pointer  INTERFACE_TO_SOLVER_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an interface to solver maps.

Parameters
interface_to_solver_mapsThe interface to solver maps to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5635 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_interfcoltosolrowsmapfinalise ( type(interface_column_to_solver_rows_map_type)  INTERFACE_COLUMN_TO_SOLVER_ROWS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a interface column to solver row map and deallocates all memory.

Parameters
interface_column_to_solver_rows_mapThe interface column to solver row map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5721 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_interfacetosolvermapfinalise(), and solvermapping_interfconditiontosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_interfcoltosolrowsmapinitialise ( type(interface_column_to_solver_rows_map_type)  INTERFACE_COLUMN_TO_SOLVER_ROWS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises am interface column to solver row map.

Parameters
interface_column_to_solver_rows_mapThe interface column to solver row map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5747 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_interfconditiontosolvermapfinalise ( type(interface_condition_to_solver_map_type)  INTERFACE_CONDITION_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises an interface condition to solver map and deallocates all memory.

Parameters
interface_condition_to_solver_mapThe interface condition to solver map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5448 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::errors(), base_routines::exits(), solvermapping_interfacetosolverequationsfinalise(), solvermapping_interfcoltosolrowsmapfinalise(), solvermapping_interftosolmatmapsimfinalise(), and solvermapping_interftosolmatmapssmfinalise().

Referenced by solver_mapping_finalise().

subroutine solver_mapping_routines::solvermapping_interfconditiontosolvermapinitialise ( type(interface_condition_to_solver_map_type)  INTERFACE_CONDITION_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an interface condition to solver map.

Parameters
interface_condition_to_solver_mapThe interface condition to solver map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5505 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_interfrowtosolrowsmapfinalise ( type(interface_row_to_solver_rows_map_type)  INTERFACE_ROW_TO_SOLVER_ROWS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a interface row to solver row map and deallocates all memory.

Parameters
interface_row_to_solver_rows_mapThe interface row to solver row map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5774 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_interftosolmatmapsimfinalise().

subroutine solver_mapping_routines::solvermapping_interfrowtosolrowsmapinitialise ( type(interface_row_to_solver_rows_map_type)  INTERFACE_ROW_TO_SOLVER_ROWS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises am interface row to solver row map.

Parameters
interface_row_to_solver_rows_mapThe interface row to solver row map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5800 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_interftosolmatmapsimfinalise ( type(interface_to_solver_matrix_maps_im_type)  INTERFACE_TO_SOLVER_MATRIX_MAPS_IM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises an interface to solver matrix map im and deallocates all memory.

Parameters
interface_to_solver_matrix_maps_imThe interface to solver matrix maps Im to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5827 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_interfconditiontosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_interftosolmatmapsiminitialise ( type(interface_to_solver_matrix_maps_im_type)  INTERFACE_TO_SOLVER_MATRIX_MAPS_IM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an interface to solver matrix maps im.

Parameters
interface_to_solver_matrix_maps_imThe interface to solver matrix maps Im to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5867 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_interftosolmatmapssmfinalise ( type(interface_to_solver_matrix_maps_sm_type)  INTERFACE_TO_SOLVER_MATRIX_MAPS_SM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises an interface to solver matrix map sm and deallocates all memory.

Parameters
interface_to_solver_matrix_maps_smThe interface to solver matrix maps sm to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5893 of file solver_mapping_routines.f90.

References base_routines::enters(), base_routines::exits(), solvermapping_equatscoltosolcolsmapfinalise(), solvermapping_interfacetosolvermapsfinalise(), and solvermapping_variabletosolvercolmapfinalise().

Referenced by solvermapping_interfconditiontosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_interftosolmatmapssminitialise ( type(interface_to_solver_matrix_maps_sm_type)  INTERFACE_TO_SOLVER_MATRIX_MAPS_SM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an interface to solver matrix maps sm.

Parameters
interface_to_solver_matrix_maps_smThe interface to solver matrix maps sm to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 5949 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_jaccoltosolcolsmapfinalise ( type(jacobian_col_to_solver_cols_map_type)  JACOBIAN_COL_TO_SOLVER_COLS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a Jacobian column to solver columns map and deallocates all memory.

Parameters
jacobian_col_to_solver_cols_mapThe Jacobian col to solver cols map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 5980 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_jacobiantosolvermapfinalise().

subroutine solver_mapping_routines::solvermapping_jaccoltosolcolsmapinitialise ( type(jacobian_col_to_solver_cols_map_type)  JACOBIAN_COL_TO_SOLVER_COLS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises an Jacobian column to solver columns map.

Parameters
jacobian_col_to_solver_cols_mapThe Jacobian column to solver columns map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6007 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_jacobiantosolvermapfinalise ( type(jacobian_to_solver_map_type), pointer  JACOBIAN_TO_SOLVER_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a equations set to solver matrix map and deallocates all memory.

Parameters
jacobian_to_solver_mapThe jacobian to solver map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6031 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equatstosolmatmapsjmfinalise(), solvermapping_equatstosolmatmapssmfinalise(), and solvermapping_jacobiantosolvermapinitialise().

subroutine solver_mapping_routines::solvermapping_jacobiantosolvermapinitialise ( type(jacobian_to_solver_map_type), pointer  JACOBIAN_TO_SOLVER_MATRIX_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises a Jacobian to solver maps.

Parameters
jacobian_to_solver_matrix_mapThe Jacobian to solver maps to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6064 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_solcoltoequationsmapsfinalise ( type(solver_col_to_equations_maps_type)  SOLVER_COL_TO_EQUATIONS_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver column to equations map and deallocates all memory.

Parameters
solver_col_to_equations_mapsThe solver column to equations sets map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6275 of file solver_mapping_routines.f90.

References domain_mappings::domain_mappings_mapping_finalise(), base_routines::enters(), base_routines::exits(), solvermapping_solcoltoequatssetmapfinalise(), and solvermapping_solverdoftovariablemapfinalise().

Referenced by solver_mapping_finalise().

subroutine solver_mapping_routines::solvermapping_solcoltoequationsmapsinitialise ( type(solver_col_to_equations_maps_type)  SOLVER_COL_TO_EQUATIONS_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver column to equations mapping and deallocates all memory.

Parameters
solver_col_to_equations_mapsThe solver column to equations map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6314 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_solcoltoequatssetmapfinalise ( type(solver_col_to_equations_set_map_type)  SOLVER_COL_TO_EQUATIONS_SET_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver column to equations set map and deallocates all memory.

Parameters
solver_col_to_equations_set_mapThe solver column to equations set map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6209 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_solcoltoequationsmapsfinalise().

subroutine solver_mapping_routines::solvermapping_solcoltoequatssetmapinitialise ( type(solver_col_to_equations_set_map_type)  SOLVER_COL_TO_EQUATIONS_SET_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver column to equations set mapping and deallocates all memory.

Parameters
solver_col_to_equations_set_mapThe solver column to equations set map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6248 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_solcoltointerfequatsmapfinalise ( type(solver_col_to_interface_equations_map_type)  SOLVER_COL_TO_INTERFACE_EQUATIONS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver column to interface equations map and deallocates all memory.

Parameters
solver_col_to_interface_equations_mapThe solver column to interface equatiosn map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6402 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_solcoltointerfmapfinalise().

subroutine solver_mapping_routines::solvermapping_solcoltointerfequatsmapinitialise ( type(solver_col_to_interface_equations_map_type)  SOLVER_COL_TO_INTERFACE_EQUATIONS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver column to interface equations mapping.

Parameters
solver_col_to_interface_equations_mapThe solver column to interface equations map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6433 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_solcoltointerfmapfinalise ( type(solver_col_to_interface_map_type)  SOLVER_COL_TO_INTERFACE_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver column to interface map and deallocates all memory.

Parameters
solver_col_to_interface_mapThe solver column to interface map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6346 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_solcoltointerfmapinitialise ( type(solver_col_to_interface_map_type)  SOLVER_COL_TO_INTERFACE_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver column to interface mapping.

Parameters
solver_col_to_interface_mapThe solver column to interface map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6377 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_solrowtoequationsmapsfinalise ( type(solver_row_to_equations_maps_type)  SOLVER_ROW_TO_EQUATIONS_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a solver row to equations map and deallocates all memory.

Parameters
solver_row_to_equations_mapsThe solver row to equations map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6604 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_finalise().

subroutine solver_mapping_routines::solvermapping_solrowtoequationsmapsinitialise ( type(solver_row_to_equations_maps_type)  SOLVER_ROW_TO_EQUATIONS_MAPS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises a solver row to equations map.

Parameters
solver_row_to_equations_mapsThe solver row to equations map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6635 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_solvercoltodequationsmapfinalise ( type(solver_col_to_dynamic_equations_map_type)  SOLVER_COL_TO_DYNAMIC_EQUATIONS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver column to dynamic equations map and deallocates all memory.

Parameters
solver_col_to_dynamic_equations_mapThe solver column to dynamic equations map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6097 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_solcoltoequatssetmapfinalise().

subroutine solver_mapping_routines::solvermapping_solvercoltodequationsmapinitialise ( type(solver_col_to_dynamic_equations_map_type)  SOLVER_COL_TO_DYNAMIC_EQUATIONS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver column to dynamic equations mapping and deallocates all memory.

Parameters
solver_col_to_dynamic_equations_mapThe solver column to dynamic equations map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6127 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_solvercoltosequationsmapfinalise ( type(solver_col_to_static_equations_map_type)  SOLVER_COL_TO_STATIC_EQUATIONS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver column to static equations map and deallocates all memory.

Parameters
solver_col_to_static_equations_mapThe solver column to static equations map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6152 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_solcoltoequatssetmapfinalise().

subroutine solver_mapping_routines::solvermapping_solvercoltosequationsmapinitialise ( type(solver_col_to_static_equations_map_type)  SOLVER_COL_TO_STATIC_EQUATIONS_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver column to static equations mapping and deallocates all memory.

Parameters
solver_col_to_static_equations_mapThe solver column to static equations map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6182 of file solver_mapping_routines.f90.

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

subroutine solver_mapping_routines::solvermapping_solverdoftovariablemapfinalise ( type(solver_dof_to_variable_map_type)  SOLVER_DOF_TO_VARIABLE_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the solver dof to variable mapping and deallocates all memory.

Parameters
solver_dof_to_variable_mapThe solver dof to variable map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6458 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_solcoltoequationsmapsfinalise().

subroutine solver_mapping_routines::solvermapping_solverdoftovariablemapinitialise ( type(solver_dof_to_variable_map_type)  SOLVER_DOF_TO_VARIABLE_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises the solver dof to variable mapping.

Parameters
solver_dof_to_variable_mapThe solver dof to variable map to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 6488 of file solver_mapping_routines.f90.

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

Referenced by solver_mapping_calculate().

subroutine solver_mapping_routines::solvermapping_variabletosolvercolmapfinalise ( type(variable_to_solver_col_map_type)  VARIABLE_TO_SOLVER_COL_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a variable to solver column map and deallocates all memory.

Parameters
variable_to_solver_col_mapThe variable to solver column map to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 6763 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_equatstosolmatmapssmfinalise(), and solvermapping_interftosolmatmapssmfinalise().

subroutine solver_mapping_routines::solvermapping_variabletosolvercolmapinitialise ( type(variable_to_solver_col_map_type)  VARIABLE_TO_SOLVER_COL_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises a variable to solver column map.

Parameters
variable_to_solver_col_mapThe variable to solver column map to initalise
[out]errThe error code
[out]errorThe error string

Definition at line 6790 of file solver_mapping_routines.f90.

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

Referenced by solvermapping_interftosolmatmapssminitialise().