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

Data Types
interface	equations_mapping_dynamic_matrices_coeffs_set

interface	equations_mapping_dynamic_matrices_set

interface	equationsmapping_createfinish

interface	equationsmapping_createstart

interface	equationsmapping_destroy

interface	equationsmapping_dynamicmatricescoeffsset

interface	equationsmapping_dynamicmatricesset

interface	equationsmapping_dynamicvariabletypeset

interface	equationsmapping_residualcoeffset

interface	equationsmapping_rhscoeffset

interface	equationsmapping_rhsvariabletypeset

interface	equationsmapping_sourcecoeffset

interface	equationsmapping_sourcevariabletypeset

Functions/Subroutines
subroutine	equations_mapping_calculate (EQUATIONS_MAPPING, ERR, ERROR,)
	Calculates the equations/dofs mapping. More...

subroutine, public	equations_mapping_create_finish (EQUATIONS_MAPPING, ERR, ERROR,)
	Finishes the process of creating an equations mapping. More...

subroutine, public	equations_mapping_create_start (EQUATIONS, EQUATIONS_MAPPING, ERR, ERROR,)
	Finishes the process of creating an equations mapping for a equations set equations. More...

subroutine	equationsmapping_createvaluescachefinalise (CREATE_VALUES_CACHE, ERR, ERROR,)
	Finalises an equations mapping create values cache and deallocates all memory. More...

subroutine	equationsmapping_createvaluescacheinitialise (EQUATIONS_MAPPING, ERR, ERROR,)
	Initialises an equations mapping create values cache. More...

subroutine, public	equations_mapping_destroy (EQUATIONS_MAPPING, ERR, ERROR,)
	Destroy an equations mapping. More...

subroutine	equations_mapping_dynamic_mapping_finalise (DYNAMIC_MAPPING, ERR, ERROR,)
	Finalises the equations mapping dynamic mapping and deallocates all memory. More...

subroutine	equationsmapping_dynamicmappinginitialise (EQUATIONS_MAPPING, ERR, ERROR,)
	Initialises the equations mapping dynamic mapping. More...

subroutine	equations_mapping_dynamic_matrices_set_all (EQUATIONS_MAPPING, MASS_MATRIX, DAMPING_MATRIX, STIFFNESS_MATRIX, ERR, ERROR,)
	Sets/changes the matrices involved in dynamic equations mapping. More...

subroutine	equations_mapping_dynamic_matrices_set_1 (EQUATIONS_MAPPING, DAMPING_MATRIX, STIFFNESS_MATRIX, ERR, ERROR,)
	Sets/changes the matrices involved in a first order dynamic equations mapping. More...

subroutine	equations_mapping_dynamic_matrices_set_2 (EQUATIONS_MAPPING, MASS_MATRIX, DAMPING_MATRIX, STIFFNESS_MATRIX, ERR, ERROR,)
	Sets/changes the matrices involved in a second order dynamic equations mapping. More...

subroutine	equationsmapping_dynamicmatricescoeffsset1 (EQUATIONS_MAPPING, DAMPING_MATRIX_COEFFICIENT, STIFFNESS_MATRIX_COEFFICIENT, ERR, ERROR,)
	Sets/changes the matrix coefficients in a first order dynamic equations mapping. More...

subroutine	equationsmapping_dynamicmatricescoeffsset2 (EQUATIONS_MAPPING, MASS_MATRIX_COEFFICIENT, DAMPING_MATRIX_COEFFICIENT, STIFFNESS_MATRIX_COEFFICIENT, ERR, ERROR,)
	Sets/changes the matrix coefficients in a second order dynamic equations mapping. More...

subroutine, public	equations_mapping_dynamic_variable_type_set (EQUATIONS_MAPPING, DYNAMIC_VARIABLE_TYPE, ERR, ERROR,)
	Sets the mapping between a dependent field variable and the equations set dynamic matrices. More...

subroutine	equationsmapping_equatsjacobiantovarmapfinalise (EQUATIONS_JACOBIAN_TO_VAR_MAP, ERR, ERROR,)
	Finalises a variable to equations Jacobian map and deallocates all memory. More...

subroutine	equationsmapping_equatsjacobiantovarmapinitialise (EQUATIONS_JACOBIAN_TO_VAR_MAP, ERR, ERROR,)
	Initialises a variable to equations Jacobian map. More...

subroutine	equationsmapping_equationsmatrixtovarmapfinalise (EQUATIONS_MATRIX_TO_VAR_MAP, ERR, ERROR,)
	Finalise an equations matrix to variable maps and deallocate all memory. More...

subroutine	equationsmapping_equatsmatrixtovarmapinitialise (EQUATIONS_MATRIX_TO_VAR_MAP, ERR, ERROR,)
	Initialise an equations matrix to variable maps. More...

subroutine	equations_mapping_finalise (EQUATIONS_MAPPING, ERR, ERROR,)
	Finalises the equations mapping and deallocates all memory. More...

subroutine	equations_mapping_initialise (EQUATIONS, ERR, ERROR,)
	Initialises the equations mapping and deallocates all memory. More...

subroutine, public	equationsmapping_residualvariablesnumberset (EQUATIONS_MAPPING, NUMBER_OF_VARIABLES, ERR, ERROR,)
	Sets the mapping between a dependent field variable and the equations set residual vector. More...

subroutine	equations_mapping_linear_mapping_finalise (LINEAR_MAPPING, ERR, ERROR,)
	Finalises the equations mapping linear mapping and deallocates all memory. More...

subroutine	equations_mapping_linear_mapping_initialise (EQUATIONS_MAPPING, ERR, ERROR,)
	Initialises the equations mapping linear mapping. More...

subroutine, public	equationsmapping_linearmatricescoeffsset (EQUATIONS_MAPPING, LINEAR_MATRIX_COEFFICIENTS, ERR, ERROR,)
	Sets the coefficients for the linear equations matrices in an equation set. More...

subroutine, public	equationsmapping_linearmatricesnumberset (EQUATIONS_MAPPING, NUMBER_OF_LINEAR_EQUATIONS_MATRICES, ERR, ERROR,)
	Sets/changes the number of linear equations matrices. More...

subroutine, public	equationsmapping_linearmatricesvariabletypesset (EQUATIONS_MAPPING, LINEAR_MATRIX_VARIABLE_TYPES, ERR, ERROR,)
	Sets the mapping between the dependent field variable types and the linear equations matrices. More...

subroutine	equationsmapping_nonlinearmappingfinalise (NONLINEAR_MAPPING, ERR, ERROR,)
	Finalises the equations mapping nonlinear mapping and deallocates all memory. More...

subroutine	equationsmapping_nonlinearmappinginitialise (EQUATIONS_MAPPING, ERR, ERROR,)
	Initialises the equations mapping nonlinear mapping. More...

subroutine, public	equations_mapping_residual_coeff_set (EQUATIONS_MAPPING, RESIDUAL_COEFFICIENT, ERR, ERROR,)
	Sets the coefficient applied to the equations set residual vector. More...

subroutine, public	equationsmapping_residualvariabletypesset (EQUATIONS_MAPPING, RESIDUAL_VARIABLE_TYPES, ERR, ERROR,)
	Sets the mapping between a dependent field variable and the equations set residual vector. More...

subroutine, public	equations_mapping_rhs_coeff_set (EQUATIONS_MAPPING, RHS_COEFFICIENT, ERR, ERROR,)
	Sets the coefficient applied to the equations set RHS vector. More...

subroutine	equations_mapping_rhs_mapping_finalise (RHS_MAPPING, ERR, ERROR,)
	Finalises the equations mapping RHS mapping and deallocates all memory. More...

subroutine	equations_mapping_rhs_mapping_initialise (EQUATIONS_MAPPING, ERR, ERROR,)
	Initialises the equations mapping RHS mapping. More...

subroutine, public	equations_mapping_rhs_variable_type_set (EQUATIONS_MAPPING, RHS_VARIABLE_TYPE, ERR, ERROR,)
	Sets the mapping between a dependent field variable and the equations set rhs vector. More...

subroutine, public	equations_mapping_source_coeff_set (EQUATIONS_MAPPING, SOURCE_COEFFICIENT, ERR, ERROR,)
	Sets the coefficient applied to the equations set source vector. More...

subroutine	equations_mapping_source_mapping_finalise (SOURCE_MAPPING, ERR, ERROR,)
	Finalises the equations mapping source mapping and deallocates all memory. More...

subroutine	equations_mapping_source_mapping_initialise (EQUATIONS_MAPPING, ERR, ERROR,)
	Initialises the equations mapping source mapping. More...

subroutine, public	equations_mapping_source_variable_type_set (EQUATIONS_MAPPING, SOURCE_VARIABLE_TYPE, ERR, ERROR,)
	Sets the mapping between a source field variable and the equations set source vector. More...

subroutine	equationsmapping_vartoequatscolumnmapfinalise (VAR_TO_EQUATIONS_COLUMN_MAP, ERR, ERROR,)
	Finalise an equations mapping equations matrix map. More...

subroutine	equationsmapping_vartoequatsjacobianmapfinalise (VAR_TO_EQUATIONS_JACOBIAN_MAP, ERR, ERROR,)
	Finalises a variable to equations Jacobian map and deallocates all memory. More...

subroutine	equationsmapping_vartoequatsjacobianmapinitialise (VAR_TO_EQUATIONS_JACOBIAN_MAP, ERR, ERROR,)
	Initialises a variable to equations Jacobian map. More...

subroutine	equationsmapping_vartoequatsmatricesmapfinalise (VAR_TO_EQUATIONS_MATRICES_MAP, ERR, ERROR,)
	Finalises a variable to equations matrices map and deallocates all memory. More...

subroutine	equationsmapping_vartoequatsmatricesmapinitialise (VAR_TO_EQUATIONS_MATRICES_MAP, ERR, ERROR,)
	Initialise an equations mapping equations matrix map. More...

Detailed Description

This module handles all equations mapping routines.

Function/Subroutine Documentation

subroutine equations_mapping_routines::equations_mapping_calculate	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Calculates the equations/dofs mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to calculate
[out]	err	The error code
[out]	error	The error string

Definition at line 163 of file equations_mapping_routines.f90.

Referenced by equations_mapping_create_finish().

subroutine, public equations_mapping_routines::equations_mapping_create_finish	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finishes the process of creating an equations mapping.

Parameters

	equations_mapping	A pointer to the equations mapping
[out]	err	The error code
[out]	error	The error string

Definition at line 982 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_set_constants::equations_linear, equations_mapping_calculate(), equations_set_constants::equations_nonlinear, equations_set_constants::equations_nonlinear_bcs, equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, equationsmapping_createvaluescachefinalise(), and base_routines::exits().

subroutine, public equations_mapping_routines::equations_mapping_create_start	(	type(equations_type), pointer	EQUATIONS,
		type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finishes the process of creating an equations mapping for a equations set equations.

Parameters

	equations	A pointer to the equation to create the equations mapping from.
	equations_mapping	On return, a pointer to the equations mapping. This must not be associated on entry
[out]	err	The error code
[out]	error	The error string

Definition at line 1112 of file equations_mapping_routines.f90.

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

subroutine, public equations_mapping_routines::equations_mapping_destroy	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroy an equations mapping.

Parameters

	equations_mapping	A pointer the equations mapping to destroy
[out]	err	The error code
[out]	error	The error string

Definition at line 1438 of file equations_mapping_routines.f90.

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

Referenced by equations_routines::equations_finalise().

subroutine equations_mapping_routines::equations_mapping_dynamic_mapping_finalise	(	type(equations_mapping_dynamic_type), pointer	DYNAMIC_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the equations mapping dynamic mapping and deallocates all memory.

Parameters

	dynamic_mapping	A pointer to the dynamic mapping to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 1466 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_finalise(), and equationsmapping_dynamicmappinginitialise().

subroutine equations_mapping_routines::equations_mapping_dynamic_matrices_set_1	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		logical, intent(in)	DAMPING_MATRIX,
		logical, intent(in)	STIFFNESS_MATRIX,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets/changes the matrices involved in a first order dynamic equations mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to set the first order matrices for
[in]	damping_matrix	Is .TRUE. if the damping matrix is in the equations mapping, .FALSE. if not
[in]	stiffness_matrix	Is .TRUE. if the stiffness matrix is in the equations mapping, .FALSE. if not
[out]	err	The error code
[out]	error	The error string

Definition at line 1730 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_mapping_dynamic_matrices_set_all(), equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, and base_routines::exits().

subroutine equations_mapping_routines::equations_mapping_dynamic_matrices_set_2	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		logical, intent(in)	MASS_MATRIX,
		logical, intent(in)	DAMPING_MATRIX,
		logical, intent(in)	STIFFNESS_MATRIX,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets/changes the matrices involved in a second order dynamic equations mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to set the first order matrices for
[in]	mass_matrix	Is .TRUE. if the mass matrix is in the equations mapping, .FALSE. if not
[in]	damping_matrix	Is .TRUE. if the damping matrix is in the equations mapping, .FALSE. if not
[in]	stiffness_matrix	Is .TRUE. if the stiffness matrix is in the equations mapping, .FALSE. if not
[out]	err	The error code
[out]	error	The error string

Definition at line 1788 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_mapping_dynamic_matrices_set_all(), equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, and base_routines::exits().

subroutine equations_mapping_routines::equations_mapping_dynamic_matrices_set_all	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		logical, intent(in)	MASS_MATRIX,
		logical, intent(in)	DAMPING_MATRIX,
		logical, intent(in)	STIFFNESS_MATRIX,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets/changes the matrices involved in dynamic equations mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to set the atrices for
[in]	mass_matrix	Is .TRUE. if the mass matrix is in the equations mapping, .FALSE. if not
[in]	damping_matrix	Is .TRUE. if the damping matrix is in the equations mapping, .FALSE. if not
[in]	stiffness_matrix	Is .TRUE. if the stiffness matrix is in the equations mapping, .FALSE. if not
[out]	err	The error code
[out]	error	The error string

Definition at line 1553 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_linear, equations_set_constants::equations_nonlinear, equations_set_constants::equations_nonlinear_bcs, and base_routines::exits().

Referenced by equations_mapping_dynamic_matrices_set_1(), and equations_mapping_dynamic_matrices_set_2().

subroutine, public equations_mapping_routines::equations_mapping_dynamic_variable_type_set	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(in)	DYNAMIC_VARIABLE_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the mapping between a dependent field variable and the equations set dynamic matrices.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	dynamic_variable_type	The variable type associated with the equations set dynamic matrices.
[out]	err	The error code
[out]	error	The error string

Definition at line 1996 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_set_constants::equations_nonlinear, equations_set_constants::equations_second_order_dynamic, and base_routines::exits().

Referenced by advection_equation_routines::advection_equationssetlinearsetup(), advection_diffusion_equation_routines::advectiondiffusion_equationssetlinearsetup(), biodomain_equation_routines::biodomain_equationssetsetup(), burgers_equation_routines::burgers_equation_equations_set_setup(), darcy_equations_routines::darcy_equation_equations_set_setup(), diffusion_equation_routines::diffusion_equationssetlinearsetup(), diffusion_equation_routines::diffusion_equationssetnonlinearsetup(), monodomain_equations_routines::Monodomain_EquationsSetSubtypeSetup::monodomain_equationssetsubtypesetup(), navier_stokes_equations_routines::NAVIER_STOKES_EQUATIONS_SET_SETUP::navier_stokes_equations_set_setup(), reaction_diffusion_equation_routines::ReactionDiffusion_EquationsSetSetup::reactiondiffusion_equationssetsetup(), and stokes_equations_routines::stokes_equations_set_setup().

subroutine equations_mapping_routines::equations_mapping_finalise	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the equations mapping and deallocates all memory.

Parameters

	equations_mapping	A pointer to the equations mapping to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 2222 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_mapping_dynamic_mapping_finalise(), equations_mapping_linear_mapping_finalise(), equations_mapping_rhs_mapping_finalise(), equations_mapping_source_mapping_finalise(), equationsmapping_createvaluescachefinalise(), equationsmapping_nonlinearmappingfinalise(), and base_routines::exits().

Referenced by equations_mapping_destroy(), and equations_mapping_initialise().

subroutine equations_mapping_routines::equations_mapping_initialise	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the equations mapping and deallocates all memory.

Parameters

	equations	A pointer to the equations to initialise the equations mapping for
[out]	err	The error code
[out]	error	The error string

Definition at line 2256 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_create_start().

subroutine equations_mapping_routines::equations_mapping_linear_mapping_finalise	(	type(equations_mapping_linear_type), pointer	LINEAR_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the equations mapping linear mapping and deallocates all memory.

Parameters

	linear_mapping	A pointer to the linear mapping to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 2354 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_finalise(), and equations_mapping_linear_mapping_initialise().

subroutine equations_mapping_routines::equations_mapping_linear_mapping_initialise	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the equations mapping linear mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to initialise the linear mapping for
[out]	err	The error code
[out]	error	The error string

Definition at line 2396 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine, public equations_mapping_routines::equations_mapping_residual_coeff_set	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		real(dp), intent(in)	RESIDUAL_COEFFICIENT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the coefficient applied to the equations set residual vector.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	residual_coefficient	The coefficient applied to the equations set residual vector.
[out]	err	The error code
[out]	error	The error string

Definition at line 2903 of file equations_mapping_routines.f90.

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

subroutine, public equations_mapping_routines::equations_mapping_rhs_coeff_set	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		real(dp), intent(in)	RHS_COEFFICIENT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the coefficient applied to the equations set RHS vector.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	rhs_coefficient	The coefficient applied to the equations set RHS vector.
[out]	err	The error code
[out]	error	The error string

Definition at line 3063 of file equations_mapping_routines.f90.

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

subroutine equations_mapping_routines::equations_mapping_rhs_mapping_finalise	(	type(equations_mapping_rhs_type), pointer	RHS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the equations mapping RHS mapping and deallocates all memory.

Parameters

	rhs_mapping	A pointer to the RHS mapping to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 3103 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_finalise(), and equations_mapping_rhs_mapping_initialise().

subroutine equations_mapping_routines::equations_mapping_rhs_mapping_initialise	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the equations mapping RHS mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to initialise the RHS mapping for
[out]	err	The error code
[out]	error	The error string

Definition at line 3130 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine, public equations_mapping_routines::equations_mapping_rhs_variable_type_set	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(in)	RHS_VARIABLE_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the mapping between a dependent field variable and the equations set rhs vector.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	rhs_variable_type	The variable type associated with the equations set rhs vector. If the problem does not have a rhs vector then the variable type on input should be zero.
[out]	err	The error code
[out]	error	The error string

Definition at line 3170 of file equations_mapping_routines.f90.

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

subroutine, public equations_mapping_routines::equations_mapping_source_coeff_set	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		real(dp), intent(in)	SOURCE_COEFFICIENT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the coefficient applied to the equations set source vector.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	source_coefficient	The coefficient applied to the equations set source vector.
[out]	err	The error code
[out]	error	The error string

Definition at line 3271 of file equations_mapping_routines.f90.

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

subroutine equations_mapping_routines::equations_mapping_source_mapping_finalise	(	type(equations_mapping_source_type), pointer	SOURCE_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the equations mapping source mapping and deallocates all memory.

Parameters

	source_mapping	A pointer to the SOURCE mapping to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 3311 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_finalise(), and equations_mapping_source_mapping_initialise().

subroutine equations_mapping_routines::equations_mapping_source_mapping_initialise	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the equations mapping source mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to initialise the source mapping for
[out]	err	The error code
[out]	error	The error string

Definition at line 3338 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine, public equations_mapping_routines::equations_mapping_source_variable_type_set	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(in)	SOURCE_VARIABLE_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the mapping between a source field variable and the equations set source vector.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	source_variable_type	The variable type associated with the equations set source vector. If the problem does not have a source vector then the variable type on input should be zero.
[out]	err	The error code
[out]	error	The error string

Definition at line 3378 of file equations_mapping_routines.f90.

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

Referenced by advection_diffusion_equation_routines::advectiondiffusion_equationssetlinearsetup(), darcy_equations_routines::darcy_equation_equations_set_setup(), diffusion_equation_routines::diffusion_equationssetlinearsetup(), fitting_routines::fitting_equations_set_vectordata_setup(), poisson_equations_routines::poisson_equationssetextracellularbidomainsetup(), poisson_equations_routines::poisson_equationssetlinearsourcesetup(), poisson_equations_routines::poisson_equationssetpressurepoissonsetup(), and reaction_diffusion_equation_routines::ReactionDiffusion_EquationsSetSetup::reactiondiffusion_equationssetsetup().

subroutine equations_mapping_routines::equationsmapping_createvaluescachefinalise	(	type(equations_mapping_create_values_cache_type), pointer	CREATE_VALUES_CACHE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises an equations mapping create values cache and deallocates all memory.

Parameters

	create_values_cache	A pointer to the create values cache to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 1150 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_create_finish(), equations_mapping_finalise(), and equationsmapping_createvaluescacheinitialise().

subroutine equations_mapping_routines::equationsmapping_createvaluescacheinitialise	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises an equations mapping create values cache.

Parameters

	equations_mapping	A pointer to the create values cache
[out]	err	The error code
[out]	error	The error string

Definition at line 1179 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_set_constants::equations_linear, equations_set_constants::equations_nonlinear, equations_set_constants::equations_nonlinear_bcs, equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, equationsmapping_createvaluescachefinalise(), base_routines::errors(), and base_routines::exits().

Referenced by equations_mapping_initialise().

subroutine equations_mapping_routines::equationsmapping_dynamicmappinginitialise	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the equations mapping dynamic mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to initialise the dynamic mapping for
[out]	err	The error code
[out]	error	The error string

Definition at line 1509 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine equations_mapping_routines::equationsmapping_dynamicmatricescoeffsset1	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		real(dp), intent(in)	DAMPING_MATRIX_COEFFICIENT,
		real(dp), intent(in)	STIFFNESS_MATRIX_COEFFICIENT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets/changes the matrix coefficients in a first order dynamic equations mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	damping_matrix_coefficient	The damping matrix coefficient
[in]	stiffness_matrix_coefficient	The stiffness matrix coefficient
[out]	err	The error code
[out]	error	The error string

Definition at line 1853 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, and base_routines::exits().

subroutine equations_mapping_routines::equationsmapping_dynamicmatricescoeffsset2	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		real(dp), intent(in)	MASS_MATRIX_COEFFICIENT,
		real(dp), intent(in)	DAMPING_MATRIX_COEFFICIENT,
		real(dp), intent(in)	STIFFNESS_MATRIX_COEFFICIENT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets/changes the matrix coefficients in a second order dynamic equations mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	mass_matrix_coefficient	The mass matrix coefficient
[in]	damping_matrix_coefficient	The damping matrix coefficient
[in]	stiffness_matrix_coefficient	The stiffness matrix coefficient
[out]	err	The error code
[out]	error	The error string

Definition at line 1923 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, and base_routines::exits().

subroutine equations_mapping_routines::equationsmapping_equationsmatrixtovarmapfinalise	(	type(equations_matrix_to_var_map_type)	EQUATIONS_MATRIX_TO_VAR_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise an equations matrix to variable maps and deallocate all memory.

Parameters

	equations_matrix_to_var_map	The equations matrix to variable map to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 2166 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_dynamic_mapping_finalise(), and equations_mapping_linear_mapping_finalise().

subroutine equations_mapping_routines::equationsmapping_equatsjacobiantovarmapfinalise	(	type(equations_jacobian_to_var_map_type)	EQUATIONS_JACOBIAN_TO_VAR_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises a variable to equations Jacobian map and deallocates all memory.

Parameters

	equations_jacobian_to_var_map	The equations Jacobian to variable map to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 2110 of file equations_mapping_routines.f90.

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

Referenced by equationsmapping_nonlinearmappingfinalise().

subroutine equations_mapping_routines::equationsmapping_equatsjacobiantovarmapinitialise	(	type(equations_jacobian_to_var_map_type)	EQUATIONS_JACOBIAN_TO_VAR_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises a variable to equations Jacobian map.

Parameters

	equations_jacobian_to_var_map	The equations Jacobian to variable map to initialise
[out]	err	The error code
[out]	error	The error string

Definition at line 2136 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine equations_mapping_routines::equationsmapping_equatsmatrixtovarmapinitialise	(	type(equations_matrix_to_var_map_type)	EQUATIONS_MATRIX_TO_VAR_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialise an equations matrix to variable maps.

Parameters

	equations_matrix_to_var_map	The equations matrix to variable map to initialise
[out]	err	The error code
[out]	error	The error string

Definition at line 2192 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine, public equations_mapping_routines::equationsmapping_linearmatricescoeffsset	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		real(dp), dimension(:), intent(in)	LINEAR_MATRIX_COEFFICIENTS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the coefficients for the linear equations matrices in an equation set.

Parameters

	equations_mapping	A pointer to the equations mapping.
[in]	linear_matrix_coefficients	The linear matrix coefficients
[out]	err	The error code
[out]	error	The error string

Definition at line 2434 of file equations_mapping_routines.f90.

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

subroutine, public equations_mapping_routines::equationsmapping_linearmatricesnumberset	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(in)	NUMBER_OF_LINEAR_EQUATIONS_MATRICES,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the number of linear equations matrices.

Parameters

	equations_mapping	A pointer to the equations mapping to set the number of matrices for.
[in]	number_of_linear_equations_matrices	The number of linear equations matrices for the mapping.
[out]	err	The error code
[out]	error	The error string

Definition at line 2484 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_set_constants::equations_linear, equations_set_constants::equations_nonlinear, equations_set_constants::equations_nonlinear_bcs, equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, and base_routines::exits().

subroutine, public equations_mapping_routines::equationsmapping_linearmatricesvariabletypesset	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), dimension(:), intent(in)	LINEAR_MATRIX_VARIABLE_TYPES,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the mapping between the dependent field variable types and the linear equations matrices.

Parameters

	equations_mapping	A pointer to the equations mapping
[in]	linear_matrix_variable_types	The matrix variable types to map to each linear equations matrix
[out]	err	The error code
[out]	error	The error string

Definition at line 2716 of file equations_mapping_routines.f90.

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

Referenced by advection_diffusion_equation_routines::advectiondiffusion_equationssetlinearsetup(), biodomain_equation_routines::biodomain_equationssetsetup(), burgers_equation_routines::burgers_equation_equations_set_setup(), characteristic_equation_routines::characteristic_equationssetsetup(), darcy_equations_routines::darcy_equation_equations_set_setup(), diffusion_equation_routines::diffusion_equationssetlinearsetup(), fitting_routines::fitting_equations_set_mat_properties_setup(), fitting_routines::fitting_equations_set_standard_setup(), fitting_routines::fitting_equations_set_vectordata_setup(), helmholtz_equations_routines::Helmholtz_EquationsSetStandardSetup::helmholtz_equationssetstandardsetup(), hamilton_jacobi_equations_routines::HJ_EQUATION_EQUATIONS_SET_STANDARD_SETUP::hj_equation_equations_set_standard_setup(), laplace_equations_routines::laplace_equationssetgeneralisedsetup(), laplace_equations_routines::laplace_equationssetmovingmeshsetup(), laplace_equations_routines::laplace_equationssetstandardsetup(), linear_elasticity_routines::linear_elasticity_equations_set_setup(), navier_stokes_equations_routines::NAVIER_STOKES_EQUATIONS_SET_SETUP::navier_stokes_equations_set_setup(), poiseuille_equations_routines::poiseuille_equationssetstaticsetup(), poisson_equations_routines::poisson_equationssetextracellularbidomainsetup(), poisson_equations_routines::poisson_equationssetlinearsourcesetup(), poisson_equations_routines::poisson_equationssetnonlinearsourcesetup(), poisson_equations_routines::poisson_equationssetpressurepoissonsetup(), stokes_equations_routines::stokes_equations_set_setup(), and stree_equation_routines::stree_equationssetsetup().

subroutine equations_mapping_routines::equationsmapping_nonlinearmappingfinalise	(	type(equations_mapping_nonlinear_type), pointer	NONLINEAR_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the equations mapping nonlinear mapping and deallocates all memory.

Parameters

	nonlinear_mapping	A pointer to the nonlinear mapping to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 2825 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_finalise(), and equationsmapping_nonlinearmappinginitialise().

subroutine equations_mapping_routines::equationsmapping_nonlinearmappinginitialise	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the equations mapping nonlinear mapping.

Parameters

	equations_mapping	A pointer to the equations mapping to initialise the nonlinear mapping for
[out]	err	The error code
[out]	error	The error string

Definition at line 2864 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine, public equations_mapping_routines::equationsmapping_residualvariablesnumberset	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), intent(in)	NUMBER_OF_VARIABLES,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the mapping between a dependent field variable and the equations set residual vector.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	number_of_variables	The number of residual variables for this equations set.
[out]	err	The error code
[out]	error	The error string

Definition at line 2302 of file equations_mapping_routines.f90.

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

Referenced by darcy_pressure_equations_routines::darcy_pressure_equation_equations_set_setup(), and finite_elasticity_routines::finite_elasticity_equations_set_setup().

subroutine, public equations_mapping_routines::equationsmapping_residualvariabletypesset	(	type(equations_mapping_type), pointer	EQUATIONS_MAPPING,
		integer(intg), dimension(:), intent(in)	RESIDUAL_VARIABLE_TYPES,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the mapping between a dependent field variable and the equations set residual vector.

Parameters

	equations_mapping	A pointer to the equations mapping to set
[in]	residual_variable_types	RESIDUAL_VARIABLE_TYPE(variable_idx). The variable_idx'th variable type associated with the equations set residual vector. The first variable type must correspond to the diagonal terms in the full solver Jacobian so that the solver mapping can use boundary conditions on this first variable to decide whether to keep rows.
[out]	err	The error code
[out]	error	The error string

Definition at line 2939 of file equations_mapping_routines.f90.

References base_routines::enters(), equations_set_constants::equations_first_order_dynamic, equations_set_constants::equations_nonlinear, equations_set_constants::equations_quasistatic, equations_set_constants::equations_second_order_dynamic, equations_set_constants::equations_static, and base_routines::exits().

Referenced by burgers_equation_routines::burgers_equation_equations_set_setup(), darcy_pressure_equations_routines::darcy_pressure_equation_equations_set_setup(), diffusion_equation_routines::diffusion_equationssetnonlinearsetup(), finite_elasticity_routines::finite_elasticity_equations_set_setup(), and navier_stokes_equations_routines::NAVIER_STOKES_EQUATIONS_SET_SETUP::navier_stokes_equations_set_setup().

subroutine equations_mapping_routines::equationsmapping_vartoequatscolumnmapfinalise	(	type(var_to_equations_column_map_type)	VAR_TO_EQUATIONS_COLUMN_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise an equations mapping equations matrix map.

Parameters

	var_to_equations_column_map	The variable dof to equations column map to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 3457 of file equations_mapping_routines.f90.

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

Referenced by equationsmapping_vartoequatsmatricesmapfinalise().

subroutine equations_mapping_routines::equationsmapping_vartoequatsjacobianmapfinalise	(	type(var_to_equations_jacobian_map_type)	VAR_TO_EQUATIONS_JACOBIAN_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises a variable to equations Jacobian map and deallocates all memory.

Parameters

	var_to_equations_jacobian_map	The variable to equations Jacobian map to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 3483 of file equations_mapping_routines.f90.

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

Referenced by equationsmapping_nonlinearmappingfinalise().

subroutine equations_mapping_routines::equationsmapping_vartoequatsjacobianmapinitialise	(	type(var_to_equations_jacobian_map_type)	VAR_TO_EQUATIONS_JACOBIAN_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises a variable to equations Jacobian map.

Parameters

	var_to_equations_jacobian_map	The variable to equations Jacobian map to initialise
[out]	err	The error code
[out]	error	The error string

Definition at line 3511 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

subroutine equations_mapping_routines::equationsmapping_vartoequatsmatricesmapfinalise	(	type(var_to_equations_matrices_map_type)	VAR_TO_EQUATIONS_MATRICES_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises a variable to equations matrices map and deallocates all memory.

Parameters

	var_to_equations_matrices_map	The variable to equations matrices map to initialise
[out]	err	The error code
[out]	error	The error string

Definition at line 3537 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_dynamic_mapping_finalise(), and equations_mapping_linear_mapping_finalise().

subroutine equations_mapping_routines::equationsmapping_vartoequatsmatricesmapinitialise	(	type(var_to_equations_matrices_map_type)	VAR_TO_EQUATIONS_MATRICES_MAP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialise an equations mapping equations matrix map.

Parameters

	var_to_equations_matrices_map	The variable to equations matrices map to initialise
[out]	err	The error code
[out]	error	The error string

Definition at line 3573 of file equations_mapping_routines.f90.

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

Referenced by equations_mapping_calculate().

Data Types

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation