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

Functions/Subroutines
subroutine, public	equations_set_analytic_create_finish (EQUATIONS_SET, ERR, ERROR,)
	Finish the creation of a analytic solution for equations set. More...

subroutine, public	equations_set_analytic_create_start (EQUATIONS_SET, ANALYTIC_FUNCTION_TYPE, ANALYTIC_FIELD_USER_NUMBER, ANALYTIC_FIELD, ERR, ERROR,)
	Start the creation of a analytic solution for a equations set. More...

subroutine, public	equations_set_analytic_destroy (EQUATIONS_SET, ERR, ERROR,)
	Destroy the analytic solution for an equations set. More...

subroutine, public	equations_set_analytic_evaluate (EQUATIONS_SET, ERR, ERROR,)
	Evaluates the current analytic solution for an equations set. More...

subroutine	equations_set_analytic_finalise (EQUATIONS_SET_ANALYTIC, ERR, ERROR,)
	Finalise the analytic solution for an equations set and deallocate all memory. More...

subroutine	equations_set_analytic_functions_evaluate (EQUATIONS_SET, ANALYTIC_FUNCTION_TYPE, POSITION, TANGENTS, NORMAL, TIME, VARIABLE_TYPE, GLOBAL_DERIVATIVE, COMPONENT_NUMBER, ANALYTIC_PARAMETERS, MATERIALS_PARAMETERS, VALUE, ERR, ERROR,)
	Evaluate the analytic solution for an equations set. More...

subroutine	equations_set_analytic_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the analytic solution for an equations set. More...

subroutine, public	equations_set_analytic_time_get (EQUATIONS_SET, TIME, ERR, ERROR,)
	Returns the analytic time for an equations set. More...

subroutine, public	equations_set_analytic_time_set (EQUATIONS_SET, TIME, ERR, ERROR,)
	Sets/changes the analytic time for an equations set. More...

subroutine, public	equations_set_analytic_user_param_set (EQUATIONS_SET, PARAM_IDX, PARAM, ERR, ERROR,)
	Sets the analytic problem user parameter. More...

subroutine, public	equations_set_analytic_user_param_get (EQUATIONS_SET, PARAM_IDX, PARAM, ERR, ERROR,)
	Sets the analytic problem user parameter. More...

subroutine, public	equations_set_assemble (EQUATIONS_SET, ERR, ERROR,)
	Assembles the equations for an equations set. More...

subroutine	equations_set_assemble_dynamic_linear_fem (EQUATIONS_SET, ERR, ERROR,)
	Assembles the equations stiffness matrix and rhs for a dynamic linear equations set using the finite element method. More...

subroutine	equations_set_assemble_static_linear_fem (EQUATIONS_SET, ERR, ERROR,)
	Assembles the equations stiffness matrix and rhs for a linear static equations set using the finite element method. More...

subroutine	equations_set_assemble_static_nonlinear_fem (EQUATIONS_SET, ERR, ERROR,)
	Assembles the equations stiffness matrix, residuals and rhs for a nonlinear static equations set using the finite element method. More...

subroutine	equationsset_assemblequasistaticnonlinearfem (EQUATIONS_SET, ERR, ERROR,)
	Assembles the equations stiffness matrix, residuals and rhs for a nonlinear quasistatic equations set using the finite element method. currently the same as the static nonlinear case. More...

subroutine	equationsset_assemblequasistaticlinearfem (EQUATIONS_SET, ERR, ERROR,)
	Assembles the equations stiffness matrix and rhs for a linear quasistatic equations set using the finite element method. More...

subroutine, public	equations_set_backsubstitute (EQUATIONS_SET, BOUNDARY_CONDITIONS, ERR, ERROR,)
	Backsubstitutes with an equations set to calculate unknown right hand side vectors. More...

subroutine, public	equations_set_nonlinear_rhs_update (EQUATIONS_SET, BOUNDARY_CONDITIONS, ERR, ERROR,)
	Updates the right hand side variable from the equations residual vector. More...

subroutine, public	equations_set_boundary_conditions_analytic (EQUATIONS_SET, BOUNDARY_CONDITIONS, ERR, ERROR,)
	Set boundary conditions for an equation set according to the analytic equations. More...

subroutine, public	equations_set_create_finish (EQUATIONS_SET, ERR, ERROR,)
	Finishes the process of creating an equation set on a region. More...

subroutine, public	equations_set_create_start (USER_NUMBER, REGION, GEOM_FIBRE_FIELD, EQUATIONS_SET_SPECIFICATION, EQUATIONS_SET_FIELD_USER_NUMBER, EQUATIONS_SET_FIELD_FIELD, EQUATIONS_SET, ERR, ERROR,)
	Starts the process of creating an equations set defined by USER_NUMBER in the region identified by REGION. More...

subroutine	equations_set_destroy_number (USER_NUMBER, REGION, ERR, ERROR,)
	Destroys an equations set identified by a user number on the give region and deallocates all memory. More...

subroutine, public	equations_set_destroy (EQUATIONS_SET, ERR, ERROR,)
	Destroys an equations set identified by a pointer and deallocates all memory. More...

subroutine	equations_set_finalise (EQUATIONS_SET, ERR, ERROR,)
	Finalise the equations set and deallocate all memory. More...

subroutine	equations_set_finite_element_calculate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
	Calculates the element stiffness matries and rhs vector for the given element number for a finite element equations set. More...

subroutine	equationsset_finiteelementjacobianevaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
	Evaluates the element Jacobian for the given element number for a finite element equations set. More...

subroutine	equationsset_finiteelementjacobianevaluatefd (equationsSet, elementNumber, jacobianNumber, err, error,)
	Evaluates the element Jacobian matrix entries using finite differencing for a general finite element equations set. More...

subroutine	equationsset_finiteelementresidualevaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
	Evaluates the element residual and rhs vector for the given element number for a finite element equations set. More...

subroutine, public	equations_set_independent_create_finish (EQUATIONS_SET, ERR, ERROR,)
	Finish the creation of independent variables for an equations set. More...

subroutine, public	equations_set_independent_create_start (EQUATIONS_SET, INDEPENDENT_FIELD_USER_NUMBER, INDEPENDENT_FIELD, ERR, ERROR,)
	Start the creation of independent variables for an equations set. More...

subroutine, public	equations_set_independent_destroy (EQUATIONS_SET, ERR, ERROR,)
	Destroy the independent field for an equations set. More...

subroutine	equations_set_independent_finalise (EQUATIONS_SET_INDEPENDENT, ERR, ERROR,)
	Finalise the independent field for an equations set. More...

subroutine	equations_set_independent_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the independent field for an equations set. More...

subroutine	equations_set_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises an equations set. More...

subroutine	equations_set_geometry_finalise (EQUATIONS_SET_GEOMETRY, ERR, ERROR,)
	Finalise the geometry for an equations set. More...

subroutine	equations_set_geometry_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the geometry for an equation set. More...

subroutine, public	equations_set_materials_create_finish (EQUATIONS_SET, ERR, ERROR,)
	Finish the creation of materials for an equations set. More...

subroutine, public	equations_set_materials_create_start (EQUATIONS_SET, MATERIALS_FIELD_USER_NUMBER, MATERIALS_FIELD, ERR, ERROR,)
	Start the creation of materials for a problem. More...

subroutine, public	equations_set_materials_destroy (EQUATIONS_SET, ERR, ERROR,)
	Destroy the materials for an equations set. More...

subroutine	equations_set_materials_finalise (EQUATIONS_SET_MATERIALS, ERR, ERROR,)
	Finalise the materials for an equations set. More...

subroutine	equations_set_materials_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the materials for an equations set. More...

subroutine, public	equations_set_dependent_create_finish (EQUATIONS_SET, ERR, ERROR,)
	Finish the creation of a dependent variables for an equations set. More...

subroutine, public	equations_set_dependent_create_start (EQUATIONS_SET, DEPENDENT_FIELD_USER_NUMBER, DEPENDENT_FIELD, ERR, ERROR,)
	Start the creation of dependent variables for an equations set. More...

subroutine, public	equations_set_dependent_destroy (EQUATIONS_SET, ERR, ERROR,)
	Destroy the dependent variables for an equations set. More...

subroutine	equations_set_dependent_finalise (EQUATIONS_SET_DEPENDENT, ERR, ERROR,)
	Finalises the dependent variables for an equation set and deallocates all memory. More...

subroutine	equations_set_dependent_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the dependent variables for a equations set. More...

subroutine, public	equationsset_derivedcreatefinish (equationsSet, err, error,)
	Finish the creation of a derived variables field for an equations set. More...

subroutine, public	equationsset_derivedcreatestart (equationsSet, derivedFieldUserNumber, derivedField, err, error,)
	Start the creation of derived variables field for an equations set. More...

subroutine, public	equationsset_deriveddestroy (equationsSet, err, error,)
	Destroy the derived variables for an equations set. More...

subroutine	equationsset_derivedfinalise (equationsSetDerived, err, error,)
	Finalises the derived variables for an equation set and deallocates all memory. More...

subroutine	equationsset_derivedinitialise (equationsSet, err, error,)
	Initialises the derived variables for a equations set. More...

subroutine	equations_set_equations_set_field_finalise (EQUATIONS_SET_FIELD, ERR, ERROR,)
	Finalises the dependent variables for an equation set and deallocates all memory. More...

subroutine	equationsset_equationssetfieldinitialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the equations set field for a equations set. More...

subroutine	equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP_INFO, ERR, ERROR,)
	Sets up the specifices for an equation set. More...

subroutine, public	equations_set_equations_create_finish (EQUATIONS_SET, ERR, ERROR,)
	Finish the creation of equations for the equations set. More...

subroutine, public	equations_set_equations_create_start (EQUATIONS_SET, EQUATIONS, ERR, ERROR,)
	Start the creation of equations for the equation set. More...

subroutine, public	equations_set_equations_destroy (EQUATIONS_SET, ERR, ERROR,)
	Destroy the equations for an equations set. More...

subroutine, public	equations_set_jacobian_evaluate (EQUATIONS_SET, ERR, ERROR,)
	Evaluates the Jacobian for a nonlinear equations set. More...

subroutine	equations_set_jacobian_evaluate_static_fem (EQUATIONS_SET, ERR, ERROR,)
	Evaluates the Jacobian for an static equations set using the finite element method. More...

subroutine	equations_set_jacobian_evaluate_dynamic_fem (EQUATIONS_SET, ERR, ERROR,)
	Evaluates the Jacobian for an dynamic equations set using the finite element method. More...

subroutine, public	equations_set_residual_evaluate (EQUATIONS_SET, ERR, ERROR,)
	Evaluates the residual for an equations set. More...

subroutine	equations_set_residual_evaluate_dynamic_fem (EQUATIONS_SET, ERR, ERROR,)
	Evaluates the residual for an dynamic equations set using the finite element method. More...

subroutine	equations_set_residual_evaluate_static_fem (EQUATIONS_SET, ERR, ERROR,)
	Evaluates the residual for an static equations set using the finite element method. More...

subroutine	equations_set_setup_finalise (EQUATIONS_SET_SETUP_INFO, ERR, ERROR,)
	Finalises the equations set setup and deallocates all memory. More...

subroutine	equations_set_setup_initialise (EQUATIONS_SET_SETUP_INFO, ERR, ERROR,)
	Initialise the equations set setup. More...

subroutine, public	equations_set_solution_method_set (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
	Sets/changes the solution method for an equations set. More...

subroutine, public	equations_set_solution_method_get (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
	Returns the solution method for an equations set. More...

subroutine, public	equations_set_source_create_finish (EQUATIONS_SET, ERR, ERROR,)
	Finish the creation of a source for an equation set. More...

subroutine, public	equations_set_source_create_start (EQUATIONS_SET, SOURCE_FIELD_USER_NUMBER, SOURCE_FIELD, ERR, ERROR,)
	Start the creation of a source for an equations set. More...

subroutine, public	equations_set_source_destroy (EQUATIONS_SET, ERR, ERROR,)
	Destroy the source for an equations set. More...

subroutine	equations_set_source_finalise (EQUATIONS_SET_SOURCE, ERR, ERROR,)
	Finalise the source for a equations set and deallocate all memory. More...

subroutine	equations_set_source_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the source for an equations set. More...

subroutine, public	equationsset_specificationget (equationsSet, equationsSetSpecification, err, error,)
	Returns the equations set specification i.e., equations set class, type and subtype for an equations set. More...

subroutine, public	equationsset_specificationsizeget (equationsSet, specificationSize, err, error,)
	Gets the size of the equations set specification array for a problem identified by a pointer. More...

subroutine, public	equationsset_derivedvariablecalculate (equationsSet, derivedType, err, error,)
	Calculates a derived variable value for the equations set. More...

subroutine, public	equationsset_derivedvariableset (equationsSet, derivedType, fieldVariableType, err, error,)
	Sets the field variable type of the derived field to be used to store a derived variable. More...

subroutine	equationsset_specificationset (equationsSet, specification, err, error,)
	Sets/changes the equations set specification i.e., equations set class, type and subtype for an equations set. More...

subroutine, public	equationsset_tensorinterpolatexi (equationsSet, tensorEvaluateType, userElementNumber, xi, values, err, error,)
	Evaluate a tensor at a given element xi location. More...

subroutine, public	equations_set_user_number_find (USER_NUMBER, REGION, EQUATIONS_SET, ERR, ERROR,)
	Finds and returns in EQUATIONS_SET a pointer to the equations set identified by USER_NUMBER in the given REGION. If no equations set with that USER_NUMBER exists EQUATIONS_SET is left nullified. More...

subroutine, public	equations_sets_finalise (REGION, ERR, ERROR,)
	Finalises all equations sets on a region and deallocates all memory. More...

subroutine, public	equations_sets_initialise (REGION, ERR, ERROR,)
	Intialises all equations sets on a region. More...

subroutine	equations_set_boundary_conditions_increment (EQUATIONS_SET, BOUNDARY_CONDITIONS, ITERATION_NUMBER, MAXIMUM_NUMBER_OF_ITERATIONS, ERR, ERROR,)
	Apply the boundary condition load increment to dependent field. More...

subroutine, public	equations_set_load_increment_apply (EQUATIONS_SET, BOUNDARY_CONDITIONS, ITERATION_NUMBER, MAXIMUM_NUMBER_OF_ITERATIONS, ERR, ERROR,)
	Apply load increments for equations sets. More...

subroutine	equationsset_assemblestaticnonlinearnodal (equationsSet, err, error,)
	Assembles the equations stiffness matrix, residuals and rhs for a nonlinear static equations set using a nodal method. More...

subroutine	equationsset_nodaljacobianevaluate (equationsSet, nodeNumber, err, error,)
	Evaluates the nodal Jacobian for the given node number for a nodal equations set. More...

subroutine	equationsset_nodalresidualevaluate (equationsSet, nodeNumber, err, error,)
	Evaluates the nodal residual and rhs vector for the given node number for a nodal equations set. More...

subroutine	equationsset_jacobianevaluatestaticnodal (equationsSet, err, error,)
	Evaluates the Jacobian for an static equations set using the finite nodal method. More...

subroutine	equationsset_residualevaluatestaticnodal (equationsSet, err, error,)
	Evaluates the residual for an static equations set using the nodal method. More...

Detailed Description

This module handles all equations set routines.

Function/Subroutine Documentation

subroutine, public equations_set_routines::equations_set_analytic_create_finish	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finish the creation of a analytic solution for equations set.

See also: OPENCMISS::CMISSEquationsSetAnalyticCreateFinish

Parameters

	equations_set	A pointer to the equations set to create the analytic for.
[out]	err	The error code
[out]	error	The error string

Definition at line 167 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_constants::equations_set_setup_analytic_type, equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_setup_initialise(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_analytic_create_start	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	ANALYTIC_FUNCTION_TYPE,
		integer(intg), intent(in)	ANALYTIC_FIELD_USER_NUMBER,
		type(field_type), pointer	ANALYTIC_FIELD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Start the creation of a analytic solution for a equations set.

See also: OPENCMISS::CMISSEquationsSetAnalyticCreateStart

Parameters

	equations_set	A pointer to the equations set to start the creation of an analytic for.
[in]	analytic_function_type	The analytic function type to setup

See also: EQUATIONS_SET_CONSTANTS::AnalyticFunctionTypes,EQUATIONS_SET_CONSTANTS

Parameters

[in]	analytic_field_user_number	The user specified analytic field number
	analytic_field	If associated on entry, a pointer to the user created analytic field which has the same user number as the specified analytic field user number. If not associated on entry, on exit, a pointer to the created analytic field for the equations set.
[out]	err	The error code
[out]	error	The error string

Definition at line 219 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_analytic_finalise(), equations_set_analytic_initialise(), equations_set_setup(), equations_set_constants::equations_set_setup_analytic_type, equations_set_setup_finalise(), equations_set_setup_initialise(), equations_set_constants::equations_set_setup_start_action, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_analytic_destroy	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroy the analytic solution for an equations set.

See also: OPENCMISS::CMISSEquationsSetAnalyticDestroy

Parameters

	equations_set	A pointer to the equations set to destroy the analytic solutins for.
[out]	err	The error code
[out]	error	The error string

Definition at line 332 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equations_set_analytic_evaluate	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Evaluates the current analytic solution for an equations set.

See also: OPENCMISS::CMISSEquationsSetAnalyticEvaluate

Parameters

	equations_set	A pointer to the equations set to evaluate the current analytic solutins for.
[out]	err	The error code
[out]	error	The error string

Definition at line 363 of file equations_set_routines.f90.

References basis_routines::basis_default_quadrature_scheme, coordinate_routines::coordinate_jacobian_no_type, base_routines::enters(), equations_set_analytic_functions_evaluate(), base_routines::exits(), constants::first_part_deriv, constants::no_part_deriv, and constants::no_physical_deriv.

subroutine equations_set_routines::equations_set_analytic_finalise	(	type(equations_set_analytic_type), pointer	EQUATIONS_SET_ANALYTIC,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise the analytic solution for an equations set and deallocate all memory.

Parameters

	equations_set_analytic	A pointer to the equations set analytic to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 705 of file equations_set_routines.f90.

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

Referenced by equations_set_analytic_create_start(), equations_set_analytic_destroy(), equations_set_analytic_initialise(), and equations_set_finalise().

subroutine equations_set_routines::equations_set_analytic_functions_evaluate	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	ANALYTIC_FUNCTION_TYPE,
		real(dp), dimension(:), intent(in)	POSITION,
		real(dp), dimension(:,:), intent(in)	TANGENTS,
		real(dp), dimension(:), intent(in)	NORMAL,
		real(dp), intent(in)	TIME,
		integer(intg), intent(in)	VARIABLE_TYPE,
		integer(intg), intent(in)	GLOBAL_DERIVATIVE,
		integer(intg), intent(in)	COMPONENT_NUMBER,
		real(dp), dimension(:), intent(in)	ANALYTIC_PARAMETERS,
		real(dp), dimension(:), intent(in)	MATERIALS_PARAMETERS,
		real(dp), intent(out)	VALUE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Evaluate the analytic solution for an equations set.

Parameters

	equations_set	A pointer to the equations set to evaluate the analytic for
[in]	analytic_function_type	The type of analytic function to evaluate
[in]	position	POSITION(dimention_idx). The geometric position to evaluate at
[in]	tangents	TANGENTS(dimention_idx,xi_idx). The geometric tangents at the point to evaluate at.
[in]	normal	NORMAL(dimension_idx). The normal vector at the point to evaluate at.
[in]	time	The time to evaluate at
[in]	variable_type	The field variable type to evaluate at
[in]	global_derivative	The global derivative direction to evaluate at
[in]	component_number	The dependent field component number to evaluate
[in]	analytic_parameters	A pointer to any analytic field parameters
[in]	materials_parameters	A pointer to any materials field parameters
[out]	value	On return, the analtyic function value.
[out]	err	The error code
[out]	error	The error string

Definition at line 731 of file equations_set_routines.f90.

References classical_field_routines::classical_field_analytic_functions_evaluate(), base_routines::enters(), equations_set_constants::equations_set_bioelectrics_class, equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_elasticity_class, equations_set_constants::equations_set_electromagnetics_class, equations_set_constants::equations_set_fitting_class, equations_set_constants::equations_set_fluid_mechanics_class, equations_set_constants::equations_set_modal_class, equations_set_constants::equations_set_multi_physics_class, and base_routines::exits().

Referenced by equations_set_analytic_evaluate().

subroutine equations_set_routines::equations_set_analytic_initialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the analytic solution for an equations set.

Parameters

	equations_set	A pointer to the equations set to initialise the analytic solution for.
[out]	err	The error code
[out]	error	The error string

Definition at line 803 of file equations_set_routines.f90.

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

Referenced by equations_set_analytic_create_start().

subroutine, public equations_set_routines::equations_set_analytic_time_get	(	type(equations_set_type), pointer	EQUATIONS_SET,
		real(dp), intent(out)	TIME,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Returns the analytic time for an equations set.

See also: OPENCMISS::CMISSEquationsSetAnalyticTimeGet

Parameters

	equations_set	A pointer to the equations set to get the time for.
[out]	time	On return, the analytic time value .
[out]	err	The error code
[out]	error	The error string

Definition at line 844 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equations_set_analytic_time_set	(	type(equations_set_type), pointer	EQUATIONS_SET,
		real(dp), intent(in)	TIME,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the analytic time for an equations set.

See also: OPENCMISS::CMISSEquationsSetAnalyticTimeSet

Parameters

	equations_set	A pointer to the equations set to set the time for.
[in]	time	The time value to set.
[out]	err	The error code
[out]	error	The error string

Definition at line 877 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equations_set_analytic_user_param_get	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	PARAM_IDX,
		real(dp), intent(out)	PARAM,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the analytic problem user parameter.

Parameters

	equations_set	A pointer to the equations set to initialise the analytic solution for.
[in]	param_idx	Index of the user parameter
[out]	param	Value of the parameter
[out]	err	The error code
[out]	error	The error string

Definition at line 949 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equations_set_analytic_user_param_set	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	PARAM_IDX,
		real(dp), intent(in)	PARAM,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the analytic problem user parameter.

Parameters

	equations_set	A pointer to the equations set to initialise the analytic solution for.
[in]	param_idx	Index of the user parameter
[in]	param	Value of the parameter
[out]	err	The error code
[out]	error	The error string

Definition at line 910 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equations_set_assemble	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Assembles the equations for an equations set.

Parameters

	equations_set	A pointer to the equations set to assemble the equations for.
[out]	err	The error code
[out]	error	The error string

Definition at line 988 of file equations_set_routines.f90.

subroutine equations_set_routines::equations_set_assemble_dynamic_linear_fem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Assembles the equations stiffness matrix and rhs for a dynamic linear equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to assemble the equations for
[out]	err	The error code
[out]	error	The error string

Definition at line 1149 of file equations_set_routines.f90.

References timer::cpu_timer(), base_routines::enters(), equations_matrices_routines::equations_matrices_element_add(), equations_matrices_routines::equations_matrices_element_calculate(), equations_matrices_routines::equations_matrices_element_finalise(), equations_matrices_routines::equations_matrices_element_initialise(), equations_matrices_routines::equations_matrices_linear_only, equations_matrices_routines::equations_matrices_output(), equations_matrices_routines::equations_matrices_values_initialise(), equations_routines::equations_matrix_output, equations_set_finite_element_calculate(), equations_routines::equations_timing_output, base_routines::exits(), base_routines::general_output_type, timer::system_cpu, and timer::user_cpu.

Referenced by equations_set_assemble(), and equations_set_jacobian_evaluate().

subroutine equations_set_routines::equations_set_assemble_static_linear_fem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Assembles the equations stiffness matrix and rhs for a linear static equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to assemble the equations for
[out]	err	The error code
[out]	error	The error string

Definition at line 1302 of file equations_set_routines.f90.

References timer::cpu_timer(), base_routines::enters(), equations_matrices_routines::equations_matrices_element_add(), equations_matrices_routines::equations_matrices_element_calculate(), equations_matrices_routines::equations_matrices_element_finalise(), equations_matrices_routines::equations_matrices_element_initialise(), equations_matrices_routines::equations_matrices_linear_only, equations_matrices_routines::equations_matrices_output(), equations_matrices_routines::equations_matrices_values_initialise(), equations_routines::equations_matrix_output, equations_set_finite_element_calculate(), equations_routines::equations_timing_output, base_routines::exits(), base_routines::general_output_type, timer::system_cpu, and timer::user_cpu.

Referenced by equations_set_assemble(), and equations_set_jacobian_evaluate().

subroutine equations_set_routines::equations_set_assemble_static_nonlinear_fem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Assembles the equations stiffness matrix, residuals and rhs for a nonlinear static equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to assemble the equations for
[out]	err	The error code
[out]	error	The error string

Definition at line 1500 of file equations_set_routines.f90.

Referenced by equations_set_assemble(), and equationsset_assemblequasistaticnonlinearfem().

subroutine, public equations_set_routines::equations_set_backsubstitute	(	type(equations_set_type), pointer	EQUATIONS_SET,
		type(boundary_conditions_type), pointer	BOUNDARY_CONDITIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Backsubstitutes with an equations set to calculate unknown right hand side vectors.

Parameters

	equations_set	A pointer to the equations set to backsubstitute
	boundary_conditions	The boundary conditions to use for the backsubstitution
[out]	err	The error code
[out]	error	The error string

Definition at line 1828 of file equations_set_routines.f90.

References boundary_conditions_routines::boundary_condition_dof_fixed, boundary_conditions_routines::boundary_condition_dof_free, boundary_conditions_routines::boundary_condition_dof_mixed, boundary_conditions_routines::boundary_conditions_variable_get(), distributed_matrix_vector::distributed_matrix_block_storage_type, distributed_matrix_vector::distributed_matrix_column_major_storage_type, distributed_matrix_vector::distributed_matrix_compressed_column_storage_type, distributed_matrix_vector::distributed_matrix_compressed_row_storage_type, distributed_matrix_vector::distributed_matrix_diagonal_storage_type, distributed_matrix_vector::distributed_matrix_row_column_storage_type, distributed_matrix_vector::distributed_matrix_row_major_storage_type, distributed_matrix_vector::distributed_matrix_storage_locations_get(), distributed_matrix_vector::distributed_matrix_storage_type_get(), base_routines::enters(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_boundary_conditions_analytic	(	type(equations_set_type), pointer	EQUATIONS_SET,
		type(boundary_conditions_type), pointer	BOUNDARY_CONDITIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Set boundary conditions for an equation set according to the analytic equations.

See also: OPENCMISS::CMISSEquationsSetBoundaryConditionsAnalytic

Parameters

	equations_set	A pointer to the equations set to set the analyticboundary conditions for.
	boundary_conditions	A pointer to the boundary conditions to set.
[out]	err	The error code
[out]	error	The error string

Definition at line 2241 of file equations_set_routines.f90.

References classical_field_routines::classicalfield_boundaryconditionsanalyticcalculate(), elasticity_routines::elasticity_boundaryconditionsanalyticcalculate(), base_routines::enters(), equations_set_constants::equations_set_bioelectrics_class, equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_elasticity_class, equations_set_constants::equations_set_electromagnetics_class, equations_set_constants::equations_set_fluid_mechanics_class, equations_set_constants::equations_set_modal_class, equations_set_constants::equations_set_multi_physics_class, base_routines::exits(), and fluid_mechanics_routines::fluidmechanics_boundaryconditionsanalyticcalculate().

subroutine equations_set_routines::equations_set_boundary_conditions_increment	(	type(equations_set_type), pointer	EQUATIONS_SET,
		type(boundary_conditions_type), pointer	BOUNDARY_CONDITIONS,
		integer(intg), intent(in)	ITERATION_NUMBER,
		integer(intg), intent(in)	MAXIMUM_NUMBER_OF_ITERATIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Apply the boundary condition load increment to dependent field.

Parameters

	boundary_conditions	The boundary conditions to apply the increment to
[in]	iteration_number	The current load increment iteration index
[in]	maximum_number_of_iterations	Final index for load increment loop
[out]	err	The error code
[out]	error	The error string

Definition at line 6500 of file equations_set_routines.f90.

References boundary_conditions_routines::boundary_condition_fixed_incremented, boundary_conditions_routines::boundary_condition_moved_wall_incremented, boundary_conditions_routines::boundary_condition_neumann_point, boundary_conditions_routines::boundary_condition_neumann_point_incremented, boundary_conditions_routines::boundary_condition_pressure_incremented, boundary_conditions_routines::boundary_conditions_variable_get(), comp_environment::computational_node_number_get(), base_routines::diagnostic_output_type, base_routines::diagnostics1, base_routines::enters(), and base_routines::exits().

Referenced by equations_set_load_increment_apply().

subroutine, public equations_set_routines::equations_set_create_finish	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finishes the process of creating an equation set on a region.

See also: OPENCMISS::CMISSEquationsSetCreateStart

Parameters

	equations_set	A pointer to the equations set to finish creating
[out]	err	The error code
[out]	error	The error string

Definition at line 2306 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_constants::equations_set_setup_geometry_type, equations_set_constants::equations_set_setup_initial_type, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_create_start	(	integer(intg), intent(in)	USER_NUMBER,
		type(region_type), pointer	REGION,
		type(field_type), pointer	GEOM_FIBRE_FIELD,
		integer(intg), dimension(:), intent(in)	EQUATIONS_SET_SPECIFICATION,
		integer(intg), intent(in)	EQUATIONS_SET_FIELD_USER_NUMBER,
		type(field_type), pointer	EQUATIONS_SET_FIELD_FIELD,
		type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Starts the process of creating an equations set defined by USER_NUMBER in the region identified by REGION.

See also

OPENCMISS::CMISSEquationsSetCreateStart Default values set for the EQUATIONS_SET's attributes are:

LINEARITY: 1 (EQUATIONS_SET_LINEAR)
TIME_DEPENDENCE: 1 (EQUATIONS_SET_STATIC)
SOLUTION_METHOD: 1 (EQUATIONS_SET_FEM_SOLUTION_METHOD)
GEOMETRY
MATERIALS
SOURCE
DEPENDENT
ANALYTIC
FIXED_CONDITIONS
EQUATIONS

Parameters

[in]	user_number	The user number of the equations set
	region	A pointer to the region to create the equations set on
	geom_fibre_field	A pointer to the either the geometry or, if appropriate, the fibre field for the equation set
[in]	equations_set_specification	The equations set specification array to set
[in]	equations_set_field_user_number	The user number of the equations set field
	equations_set_field_field	On return, a pointer to the equations set field
	equations_set	On return, a pointer to the equations set
[out]	err	The error code
[out]	error	The error string

Definition at line 2362 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_finalise(), equations_set_geometry_initialise(), equations_set_initialise(), equations_set_setup(), equations_set_setup_finalise(), equations_set_constants::equations_set_setup_geometry_type, equations_set_constants::equations_set_setup_initial_type, equations_set_setup_initialise(), equations_set_constants::equations_set_setup_start_action, equations_set_user_number_find(), equationsset_specificationset(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_dependent_create_finish	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finish the creation of a dependent variables for an equations set.

See also: OPENCMISS::CMISSEquationsSetDependentCreateFinish

Parameters

	equations_set	A pointer to the equations set to finish the creation of
[out]	err	The error code
[out]	error	The error string

Definition at line 3968 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_constants::equations_set_setup_dependent_type, equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_setup_initialise(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_dependent_create_start	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	DEPENDENT_FIELD_USER_NUMBER,
		type(field_type), pointer	DEPENDENT_FIELD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Start the creation of dependent variables for an equations set.

See also: OPENCMISS::CMISSEquationsSetDependentCreateStart

Parameters

	equations_set	A pointer to the equations set to start the creation of a dependent field on
[in]	dependent_field_user_number	The user specified dependent field number
	dependent_field	If associated on entry, a pointer to the user created dependent field which has the same user number as the specified dependent field user number. If not associated on entry, on exit, a pointer to the created dependent field for the equations set.
[out]	err	The error code
[out]	error	The error string

Definition at line 4017 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_dependent_finalise(), equations_set_setup(), equations_set_constants::equations_set_setup_dependent_type, equations_set_setup_finalise(), equations_set_setup_initialise(), equations_set_constants::equations_set_setup_start_action, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_dependent_destroy	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroy the dependent variables for an equations set.

See also: OPENCMISS::CMISSEquationsSetDependentDestroy

Parameters

	equations_set	The pointer to the equations set to destroy
[out]	err	The error code
[out]	error	The error string

Definition at line 4126 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equations_set_dependent_finalise	(	type(equations_set_dependent_type)	EQUATIONS_SET_DEPENDENT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the dependent variables for an equation set and deallocates all memory.

Parameters

	equations_set_dependent	The pointer to the equations set
[out]	err	The error code
[out]	error	The error string

Definition at line 4153 of file equations_set_routines.f90.

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

Referenced by equations_set_dependent_create_start(), equations_set_dependent_destroy(), and equations_set_finalise().

subroutine equations_set_routines::equations_set_dependent_initialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the dependent variables for a equations set.

Parameters

	equations_set	A pointer to the equations set to initialise the dependent field for
[out]	err	The error code
[out]	error	The error string

Definition at line 4179 of file equations_set_routines.f90.

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

Referenced by equations_set_initialise().

subroutine, public equations_set_routines::equations_set_destroy	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroys an equations set identified by a pointer and deallocates all memory.

See also: OPENCMISS::CMISSEquationsSetDestroy

Parameters

	equations_set	A pointer to the equations set to destroy
[out]	err	The error code
[out]	error	The error string

Definition at line 2635 of file equations_set_routines.f90.

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

Referenced by equations_sets_finalise().

subroutine equations_set_routines::equations_set_destroy_number	(	integer(intg), intent(in)	USER_NUMBER,
		type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Destroys an equations set identified by a user number on the give region and deallocates all memory.

See also: OPENCMISS::CMISSEquationsSetDestroy

Parameters

[in]	user_number	The user number of the equations set to destroy
	region	The region of the equations set to destroy
[out]	err	The error code
[out]	error	The error string

Definition at line 2552 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equations_set_equations_create_finish	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finish the creation of equations for the equations set.

See also: OPENCMISS::CMISSEquationsSetEquationsCreateFinish

Parameters

	equations_set	A pointer to the equations set to finish the creation of the equations for.
[out]	err	The error code
[out]	error	The error string

Definition at line 4583 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_constants::equations_set_setup_equations_type, equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_setup_initialise(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_equations_create_start	(	type(equations_set_type), pointer	EQUATIONS_SET,
		type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Start the creation of equations for the equation set.

See also

CMISSEquationsSetEquationsCreateStart Default values set for the EQUATIONS's attributes are:

OUTPUT_TYPE: 0 (EQUATIONS_SET_NO_OUTPUT)
SPARSITY_TYPE: 1 (EQUATIONS_SET_SPARSE_MATRICES)
NONLINEAR_JACOBIAN_TYPE: 0
INTERPOLATION: null
LINEAR_DATA: null
NONLINEAR_DATA: null
TIME_DATA: null
EQUATIONS_MAPPING:
EQUATIONS_MATRICES:

Parameters

	equations_set	A pointer to the equations set to create equations for
	equations	On exit, a pointer to the created equations. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 4628 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_constants::equations_set_setup_equations_type, equations_set_setup_finalise(), equations_set_setup_initialise(), equations_set_constants::equations_set_setup_start_action, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_equations_destroy	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroy the equations for an equations set.

See also: OPENCMISS::CMISSEquationsSetEquationsDestroy

Parameters

	equations_set	A pointer to the equations set to destroy the equations for.
[out]	err	The error code
[out]	error	The error string

Definition at line 4670 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equations_set_equations_set_field_finalise	(	type(equations_set_equations_set_field_type)	EQUATIONS_SET_FIELD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the dependent variables for an equation set and deallocates all memory.

Parameters

	equations_set_field	The pointer to the equations set
[out]	err	The error code
[out]	error	The error string

Definition at line 4462 of file equations_set_routines.f90.

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

Referenced by equations_set_finalise().

subroutine equations_set_routines::equations_set_finalise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise the equations set and deallocate all memory.

Parameters

	equations_set	A pointer to the equations set to finalise.
[out]	err	The error code
[out]	error	The error string

Definition at line 2699 of file equations_set_routines.f90.

References base_routines::enters(), equations_routines::equations_destroy(), equations_set_analytic_finalise(), equations_set_dependent_finalise(), equations_set_equations_set_field_finalise(), equations_set_geometry_finalise(), equations_set_independent_finalise(), equations_set_materials_finalise(), equations_set_source_finalise(), equationsset_derivedfinalise(), and base_routines::exits().

Referenced by equations_set_create_start(), equations_set_destroy(), equations_set_destroy_number(), and equations_set_initialise().

subroutine equations_set_routines::equations_set_finite_element_calculate	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	ELEMENT_NUMBER,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Calculates the element stiffness matries and rhs vector for the given element number for a finite element equations set.

Parameters

	equations_set	A pointer to the equations set
[in]	element_number	The element number to calcualte
[out]	err	The error code
[out]	error	The error string

Definition at line 2735 of file equations_set_routines.f90.

Referenced by equations_set_assemble_dynamic_linear_fem(), equations_set_assemble_static_linear_fem(), and equationsset_assemblequasistaticlinearfem().

subroutine equations_set_routines::equations_set_geometry_finalise	(	type(equations_set_geometry_type)	EQUATIONS_SET_GEOMETRY,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise the geometry for an equations set.

Parameters

	equations_set_geometry	A pointer to the equations set geometry to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 3655 of file equations_set_routines.f90.

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

Referenced by equations_set_finalise().

subroutine equations_set_routines::equations_set_geometry_initialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the geometry for an equation set.

Parameters

	equations_set	A pointer to the equations set to initialise the geometry for.
[out]	err	The error code
[out]	error	The error string

Definition at line 3679 of file equations_set_routines.f90.

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

Referenced by equations_set_create_start(), and equations_set_initialise().

subroutine, public equations_set_routines::equations_set_independent_create_finish	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finish the creation of independent variables for an equations set.

See also: OPENCMISS::CMISSEquationsSetIndependentCreateFinish

Parameters

	equations_set	A pointer to the equations set to finish the creation of the independent field for
[out]	err	The error code
[out]	error	The error string

Definition at line 3349 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_constants::equations_set_setup_independent_type, equations_set_setup_initialise(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_independent_create_start	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	INDEPENDENT_FIELD_USER_NUMBER,
		type(field_type), pointer	INDEPENDENT_FIELD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Start the creation of independent variables for an equations set.

See also: OPENCMISS::CMISSEquationsSetIndependentCreateStart

Parameters

	equations_set	A pointer to the equations set to start the creation of the materials field for
[in]	independent_field_user_number	The user specified independent field number
	independent_field	If associated on entry, a pointer to the user created independent field which has the same user number as the specified independent field user number. If not associated on entry, on exit, a pointer to the created independent field for the equations set.
[out]	err	The error code
[out]	error	The error string

Definition at line 3402 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_independent_finalise(), equations_set_independent_initialise(), equations_set_setup(), equations_set_setup_finalise(), equations_set_constants::equations_set_setup_independent_type, equations_set_setup_initialise(), equations_set_constants::equations_set_setup_start_action, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_independent_destroy	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroy the independent field for an equations set.

See also: OPENCMISS::CMISSEquationsSetIndependentDestroy

Parameters

	equations_set	A pointer to the equations set to destroy the independent field for
[out]	err	The error code
[out]	error	The error string

Definition at line 3513 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equations_set_independent_finalise	(	type(equations_set_independent_type), pointer	EQUATIONS_SET_INDEPENDENT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise the independent field for an equations set.

Parameters

	equations_set_independent	A pointer to the equations set independent to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 3544 of file equations_set_routines.f90.

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

Referenced by equations_set_finalise(), equations_set_independent_create_start(), equations_set_independent_destroy(), and equations_set_independent_initialise().

subroutine equations_set_routines::equations_set_independent_initialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the independent field for an equations set.

Parameters

	equations_set	A pointer to the equations set to initialise the independent for
[out]	err	The error code
[out]	error	The error string

Definition at line 3569 of file equations_set_routines.f90.

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

Referenced by equations_set_independent_create_start().

subroutine equations_set_routines::equations_set_initialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises an equations set.

Parameters

	equations_set	The pointer to the equations set to initialise
[out]	err	The error code
[out]	error	The error string

Definition at line 3608 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_dependent_initialise(), equations_set_finalise(), equations_set_geometry_initialise(), equationsset_equationssetfieldinitialise(), and base_routines::exits().

Referenced by equations_set_create_start().

subroutine, public equations_set_routines::equations_set_jacobian_evaluate	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Evaluates the Jacobian for a nonlinear equations set.

Parameters

	equations_set	A pointer to the equations set to evaluate the Jacobian for
[out]	err	The error code
[out]	error	The error string

Definition at line 4701 of file equations_set_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_assemble_dynamic_linear_fem(), equations_set_assemble_static_linear_fem(), equations_set_constants::equations_set_bem_solution_method, equations_set_constants::equations_set_fd_solution_method, equations_set_constants::equations_set_fem_solution_method, equations_set_constants::equations_set_fv_solution_method, equations_set_constants::equations_set_gfem_solution_method, equations_set_constants::equations_set_gfv_solution_method, equations_set_jacobian_evaluate_dynamic_fem(), equations_set_jacobian_evaluate_static_fem(), equations_set_constants::equations_set_nodal_solution_method, equations_set_constants::equations_static, equations_set_constants::equations_time_stepping, equationsset_assemblequasistaticlinearfem(), equationsset_jacobianevaluatestaticnodal(), and base_routines::exits().

subroutine equations_set_routines::equations_set_jacobian_evaluate_dynamic_fem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Evaluates the Jacobian for an dynamic equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to evaluate the Jacobian for
[out]	err	The error code
[out]	error	The error string

Definition at line 5038 of file equations_set_routines.f90.

Referenced by equations_set_jacobian_evaluate().

subroutine equations_set_routines::equations_set_jacobian_evaluate_static_fem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Evaluates the Jacobian for an static equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to evaluate the Jacobian for
[out]	err	The error code
[out]	error	The error string

Definition at line 4885 of file equations_set_routines.f90.

Referenced by equations_set_jacobian_evaluate().

subroutine, public equations_set_routines::equations_set_load_increment_apply	(	type(equations_set_type), pointer	EQUATIONS_SET,
		type(boundary_conditions_type), pointer	BOUNDARY_CONDITIONS,
		integer(intg), intent(in)	ITERATION_NUMBER,
		integer(intg), intent(in)	MAXIMUM_NUMBER_OF_ITERATIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Apply load increments for equations sets.

Parameters

	boundary_conditions	The boundary conditions to apply the increment to
[in]	iteration_number	The current load increment iteration index
[in]	maximum_number_of_iterations	Final index for load increment loop
[out]	err	The error code
[out]	error	The error string

Definition at line 6798 of file equations_set_routines.f90.

References elasticity_routines::elasticity_load_increment_apply(), base_routines::enters(), equations_set_boundary_conditions_increment(), equations_set_constants::equations_set_elasticity_class, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_materials_create_finish	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finish the creation of materials for an equations set.

See also: OPENCMISS::CMISSEquationsSetMaterialsCreateFinish

Parameters

	equations_set	A pointer to the equations set to finish the creation of the materials field for
[out]	err	The error code
[out]	error	The error string

Definition at line 3708 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_setup_initialise(), equations_set_constants::equations_set_setup_materials_type, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_materials_create_start	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	MATERIALS_FIELD_USER_NUMBER,
		type(field_type), pointer	MATERIALS_FIELD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Start the creation of materials for a problem.

See also: OPENCMISS::CMISSEquationsSetMaterialsCreateStart

Parameters

	equations_set	A pointer to the equations set to start the creation of the materials field for
[in]	materials_field_user_number	The user specified materials field number
	materials_field	If associated on entry, a pointer to the user created materials field which has the same user number as the specified materials field user number. If not associated on entry, on exit, a pointer to the created materials field for the equations set.
[out]	err	The error code
[out]	error	The error string

Definition at line 3761 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_materials_finalise(), equations_set_materials_initialise(), equations_set_setup(), equations_set_setup_finalise(), equations_set_setup_initialise(), equations_set_constants::equations_set_setup_materials_type, equations_set_constants::equations_set_setup_start_action, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_materials_destroy	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroy the materials for an equations set.

See also: OPENCMISS::CMISSEquationsSetMaterialsDestroy

Parameters

	equations_set	A pointer to the equations set to destroy the materials for
[out]	err	The error code
[out]	error	The error string

Definition at line 3872 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equations_set_materials_finalise	(	type(equations_set_materials_type), pointer	EQUATIONS_SET_MATERIALS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise the materials for an equations set.

Parameters

	equations_set_materials	A pointer to the equations set materials to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 3903 of file equations_set_routines.f90.

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

Referenced by equations_set_finalise(), equations_set_materials_create_start(), equations_set_materials_destroy(), and equations_set_materials_initialise().

subroutine equations_set_routines::equations_set_materials_initialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the materials for an equations set.

Parameters

	equations_set	A pointer to the equations set to initialise the materials for
[out]	err	The error code
[out]	error	The error string

Definition at line 3928 of file equations_set_routines.f90.

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

Referenced by equations_set_materials_create_start().

subroutine, public equations_set_routines::equations_set_nonlinear_rhs_update	(	type(equations_set_type), pointer	EQUATIONS_SET,
		type(boundary_conditions_type), pointer	BOUNDARY_CONDITIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Updates the right hand side variable from the equations residual vector.

Parameters

	equations_set	A pointer to the equations set
	boundary_conditions	Boundary conditions to use for the RHS update
[out]	err	The error code
[out]	error	The error string

Definition at line 2104 of file equations_set_routines.f90.

References boundary_conditions_routines::boundary_condition_dof_fixed, boundary_conditions_routines::boundary_condition_dof_free, boundary_conditions_routines::boundary_condition_dof_mixed, boundary_conditions_routines::boundary_conditions_variable_get(), base_routines::enters(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_residual_evaluate	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Evaluates the residual for an equations set.

Parameters

	equations_set	A pointer to the equations set to evaluate the residual for
[out]	err	The error code
[out]	error	The error string

Definition at line 5191 of file equations_set_routines.f90.

subroutine equations_set_routines::equations_set_residual_evaluate_dynamic_fem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Evaluates the residual for an dynamic equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to evaluate the residual for
[out]	err	The error code
[out]	error	The error string

Definition at line 5332 of file equations_set_routines.f90.

Referenced by equations_set_residual_evaluate().

subroutine equations_set_routines::equations_set_residual_evaluate_static_fem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Evaluates the residual for an static equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to evaluate the residual for
[out]	err	The error code
[out]	error	The error string

Definition at line 5490 of file equations_set_routines.f90.

Referenced by equations_set_residual_evaluate().

subroutine equations_set_routines::equations_set_setup	(	type(equations_set_type), pointer	EQUATIONS_SET,
		type(equations_set_setup_type), intent(inout)	EQUATIONS_SET_SETUP_INFO,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets up the specifices for an equation set.

Parameters

	equations_set	A pointer to the equations set to perform the setup on
[in,out]	equations_set_setup_info	The equations set setup information
[out]	err	The error code
[out]	error	The error string

Definition at line 4520 of file equations_set_routines.f90.

References bioelectric_routines::bioelectric_equations_set_setup(), classical_field_routines::classical_field_equations_set_setup(), elasticity_routines::elasticity_equations_set_setup(), base_routines::enters(), equations_set_constants::equations_set_bioelectrics_class, equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_elasticity_class, equations_set_constants::equations_set_electromagnetics_class, equations_set_constants::equations_set_fitting_class, equations_set_constants::equations_set_fluid_mechanics_class, equations_set_constants::equations_set_modal_class, equations_set_constants::equations_set_monodomain_strang_splitting_equation_type, equations_set_constants::equations_set_multi_physics_class, base_routines::exits(), fitting_routines::fitting_equations_set_setup(), and fluid_mechanics_routines::fluid_mechanics_equations_set_setup().

Referenced by equations_set_analytic_create_finish(), equations_set_analytic_create_start(), equations_set_create_finish(), equations_set_create_start(), equations_set_dependent_create_finish(), equations_set_dependent_create_start(), equations_set_equations_create_finish(), equations_set_equations_create_start(), equations_set_independent_create_finish(), equations_set_independent_create_start(), equations_set_materials_create_finish(), equations_set_materials_create_start(), equations_set_source_create_finish(), equations_set_source_create_start(), equationsset_derivedcreatefinish(), and equationsset_derivedcreatestart().

subroutine equations_set_routines::equations_set_setup_finalise	(	type(equations_set_setup_type), intent(out)	EQUATIONS_SET_SETUP_INFO,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the equations set setup and deallocates all memory.

Parameters

[out]	equations_set_setup_info	The equations set setup to be finalised
[out]	err	The error code
[out]	error	The error string

Definition at line 5643 of file equations_set_routines.f90.

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

Referenced by equations_set_analytic_create_finish(), equations_set_analytic_create_start(), equations_set_create_finish(), equations_set_create_start(), equations_set_dependent_create_finish(), equations_set_dependent_create_start(), equations_set_equations_create_finish(), equations_set_equations_create_start(), equations_set_independent_create_finish(), equations_set_independent_create_start(), equations_set_materials_create_finish(), equations_set_materials_create_start(), equations_set_source_create_finish(), equations_set_source_create_start(), equationsset_derivedcreatefinish(), and equationsset_derivedcreatestart().

subroutine equations_set_routines::equations_set_setup_initialise	(	type(equations_set_setup_type), intent(out)	EQUATIONS_SET_SETUP_INFO,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialise the equations set setup.

Parameters

[out]	equations_set_setup_info	The equations set setup to be initialised
[out]	err	The error code
[out]	error	The error string

Definition at line 5670 of file equations_set_routines.f90.

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

Referenced by equations_set_analytic_create_finish(), equations_set_analytic_create_start(), equations_set_create_start(), equations_set_dependent_create_finish(), equations_set_dependent_create_start(), equations_set_equations_create_finish(), equations_set_equations_create_start(), equations_set_independent_create_finish(), equations_set_independent_create_start(), equations_set_materials_create_finish(), equations_set_materials_create_start(), equations_set_source_create_finish(), equations_set_source_create_start(), equationsset_derivedcreatefinish(), and equationsset_derivedcreatestart().

subroutine, public equations_set_routines::equations_set_solution_method_get	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	SOLUTION_METHOD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Returns the solution method for an equations set.

See also: OPENCMISS::CMISSEquationsSetSolutionMethodGet

Parameters

	equations_set	A pointer to the equations set to get the solution method for
[out]	solution_method	On return, the equations set solution method

See also: EQUATIONS_SET_CONSTANTS::SolutionMethods,EQUATIONS_SET_CONSTANTS

Parameters

[out]	err	The error code
[out]	error	The error string

Definition at line 5763 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equations_set_solution_method_set	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	SOLUTION_METHOD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the solution method for an equations set.

See also: OPENCMISS::CMISSEquationsSetSolutionMethodSet

Parameters

	equations_set	A pointer to the equations set to set the solution method for
[in]	solution_method	The equations set solution method to set

See also: EQUATIONS_SET_CONSTANTS::SolutionMethods,EQUATIONS_SET_CONSTANTS

Parameters

[out]	err	The error code
[out]	error	The error string

Definition at line 5697 of file equations_set_routines.f90.

subroutine, public equations_set_routines::equations_set_source_create_finish	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finish the creation of a source for an equation set.

See also: OPENCMISS::CMISSEquationsSetSourceCreateFinish

Parameters

	equations_set	A pointer to the equations set to start the creation of a souce for
[out]	err	The error code
[out]	error	The error string

Definition at line 5795 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_setup_initialise(), equations_set_constants::equations_set_setup_source_type, and base_routines::exits().

subroutine, public equations_set_routines::equations_set_source_create_start	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	SOURCE_FIELD_USER_NUMBER,
		type(field_type), pointer	SOURCE_FIELD,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Start the creation of a source for an equations set.

See also: OPENCMISS::CMISSEquationsSetSourceCreateStart

Parameters

	equations_set	A pointer to the equations set to start the creation of a source for
[in]	source_field_user_number	The user specified source field number
	source_field	If associated on entry, a pointer to the user created source field which has the same user number as the specified source field user number. If not associated on entry, on exit, a pointer to the created source field for the equations set.
[out]	err	The error code
[out]	error	The error string

Definition at line 5848 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_setup_finalise(), equations_set_setup_initialise(), equations_set_constants::equations_set_setup_source_type, equations_set_constants::equations_set_setup_start_action, equations_set_source_finalise(), equations_set_source_initialise(), and base_routines::exits().

subroutine, public equations_set_routines::equations_set_source_destroy	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroy the source for an equations set.

See also: OPENCMISS::CMISSEquationsSetSourceDestroy

Parameters

	equations_set	A pointer to the equations set to destroy the source for
[out]	err	The error code
[out]	error	The error string

Definition at line 5959 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equations_set_source_finalise	(	type(equations_set_source_type), pointer	EQUATIONS_SET_SOURCE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalise the source for a equations set and deallocate all memory.

Parameters

	equations_set_source	A pointer to the equations set source to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 5990 of file equations_set_routines.f90.

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

Referenced by equations_set_finalise(), equations_set_source_create_start(), equations_set_source_destroy(), and equations_set_source_initialise().

subroutine equations_set_routines::equations_set_source_initialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the source for an equations set.

Parameters

	equations_set	A pointer to the equations set to initialise the source field for.
[out]	err	The error code
[out]	error	The error string

Definition at line 6015 of file equations_set_routines.f90.

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

Referenced by equations_set_source_create_start().

subroutine, public equations_set_routines::equations_set_user_number_find	(	integer(intg), intent(in)	USER_NUMBER,
		type(region_type), pointer	REGION,
		type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finds and returns in EQUATIONS_SET a pointer to the equations set identified by USER_NUMBER in the given REGION. If no equations set with that USER_NUMBER exists EQUATIONS_SET is left nullified.

Parameters

[in]	user_number	The user number to find the equation set
	region	The region to find the equations set in
	equations_set	On return, a pointer to the equations set if an equations set with the specified user number exists in the given region. If no equation set with the specified number exists a NULL pointer is returned. The pointer must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 6381 of file equations_set_routines.f90.

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

Referenced by equations_set_create_start().

subroutine, public equations_set_routines::equations_sets_finalise	(	type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finalises all equations sets on a region and deallocates all memory.

Parameters

	region	A pointer to the region to finalise the problems for.
[out]	err	The error code
[out]	error	The error string

Definition at line 6430 of file equations_set_routines.f90.

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

Referenced by region_routines::region_finalise().

subroutine, public equations_set_routines::equations_sets_initialise	(	type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Intialises all equations sets on a region.

Parameters

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

Definition at line 6462 of file equations_set_routines.f90.

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

Referenced by region_routines::region_initialise().

subroutine equations_set_routines::equationsset_assemblequasistaticlinearfem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Assembles the equations stiffness matrix and rhs for a linear quasistatic equations set using the finite element method.

Parameters

	equations_set	A pointer to the equations set to assemble the equations for
[out]	err	The error code
[out]	error	The error string

Definition at line 1676 of file equations_set_routines.f90.

References timer::cpu_timer(), base_routines::enters(), equations_matrices_routines::equations_matrices_element_add(), equations_matrices_routines::equations_matrices_element_calculate(), equations_matrices_routines::equations_matrices_element_finalise(), equations_matrices_routines::equations_matrices_element_initialise(), equations_matrices_routines::equations_matrices_linear_only, equations_matrices_routines::equations_matrices_output(), equations_matrices_routines::equations_matrices_values_initialise(), equations_routines::equations_matrix_output, equations_set_finite_element_calculate(), equations_routines::equations_timing_output, base_routines::exits(), base_routines::general_output_type, timer::system_cpu, and timer::user_cpu.

Referenced by equations_set_assemble(), and equations_set_jacobian_evaluate().

subroutine equations_set_routines::equationsset_assemblequasistaticnonlinearfem	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Assembles the equations stiffness matrix, residuals and rhs for a nonlinear quasistatic equations set using the finite element method. currently the same as the static nonlinear case.

Parameters

	equations_set	A pointer to the equations set to assemble the equations for
[out]	err	The error code
[out]	error	The error string

Definition at line 1653 of file equations_set_routines.f90.

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

Referenced by equations_set_assemble().

subroutine equations_set_routines::equationsset_assemblestaticnonlinearnodal	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Assembles the equations stiffness matrix, residuals and rhs for a nonlinear static equations set using a nodal method.

Parameters

	equationsset	A pointer to the equations set to assemble the equations for
[out]	err	The error code
[out]	error	The error string

Definition at line 6844 of file equations_set_routines.f90.

References timer::cpu_timer(), base_routines::enters(), equations_matrices_routines::equations_matrices_nonlinear_only, equations_matrices_routines::equations_matrices_output(), equations_matrices_routines::equations_matrices_values_initialise(), equations_routines::equations_matrix_output, equations_routines::equations_timing_output, equations_matrices_routines::equationsmatrices_nodalcalculate(), equations_matrices_routines::equationsmatrices_nodalfinalise(), equations_matrices_routines::equationsmatrices_nodalinitialise(), equations_matrices_routines::equationsmatrices_nodeadd(), equationsset_nodalresidualevaluate(), base_routines::exits(), base_routines::general_output_type, timer::system_cpu, and timer::user_cpu.

Referenced by equations_set_assemble().

subroutine, public equations_set_routines::equationsset_derivedcreatefinish	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Finish the creation of a derived variables field for an equations set.

See also: OPENCMISS::CMISSEquationsSet_DerivedCreateFinish

Parameters

	equationsset	A pointer to the equations set to finish the derived variable creation for
[out]	err	The error code
[out]	error	The error string

Definition at line 4209 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_constants::equations_set_setup_derived_type, equations_set_setup_finalise(), equations_set_constants::equations_set_setup_finish_action, equations_set_setup_initialise(), and base_routines::exits().

subroutine, public equations_set_routines::equationsset_derivedcreatestart	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(in)	derivedFieldUserNumber,
		type(field_type), pointer	derivedField,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Start the creation of derived variables field for an equations set.

See also: OPENCMISS::CMISSEquationsSet_DerivedCreateStart

Parameters

	equationsset	A pointer to the equations set to start the creation of a derived field on
[in]	derivedfieldusernumber	The user specified derived field number
	derivedfield	If associated on entry, a pointer to the user created derived field which has the same user number as the specified derived field user number. If not associated on entry, on exit, a pointer to the created derived field for the equations set.
[out]	err	The error code
[out]	error	The error string

Definition at line 4262 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_setup(), equations_set_constants::equations_set_setup_derived_type, equations_set_setup_finalise(), equations_set_setup_initialise(), equations_set_constants::equations_set_setup_start_action, equationsset_derivedfinalise(), equationsset_derivedinitialise(), and base_routines::exits().

subroutine, public equations_set_routines::equationsset_deriveddestroy	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Destroy the derived variables for an equations set.

See also: OPENCMISS::CMISSEquationsSet_DerivedDestroy

Parameters

	equationsset	The pointer to the equations set to destroy the derived fields for
[out]	err	The error code
[out]	error	The error string

Definition at line 4370 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equationsset_derivedfinalise	(	type(equationssetderivedtype), pointer	equationsSetDerived,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Finalises the derived variables for an equation set and deallocates all memory.

Parameters

	equationssetderived	The pointer to the equations set
[out]	err	The error code
[out]	error	The error string

Definition at line 4397 of file equations_set_routines.f90.

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

Referenced by equations_set_finalise(), equationsset_derivedcreatestart(), equationsset_deriveddestroy(), and equationsset_derivedinitialise().

subroutine equations_set_routines::equationsset_derivedinitialise	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Initialises the derived variables for a equations set.

Parameters

	equationsset	A pointer to the equations set to initialise the derived field for
[out]	err	The error code
[out]	error	The error string

Definition at line 4422 of file equations_set_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_number_of_derived_types, equationsset_derivedfinalise(), and base_routines::exits().

Referenced by equationsset_derivedcreatestart().

subroutine, public equations_set_routines::equationsset_derivedvariablecalculate	(	type(equations_set_type), intent(in), pointer	equationsSet,
		integer(intg), intent(in)	derivedType,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Calculates a derived variable value for the equations set.

See also: OPENCMISS::CMISSEquationsSet_DerivedVariableCalculate

Parameters

[in]	equationsset	A pointer to the equations set to calculate output for
[in]	derivedtype	The derived value type to calculate.

See also: EQUATIONS_SET_CONSTANTS::DerivedTypes.

Parameters

[out]	err	The error code
[out]	error	The error string

Definition at line 6140 of file equations_set_routines.f90.

subroutine, public equations_set_routines::equationsset_derivedvariableset	(	type(equations_set_type), intent(in), pointer	equationsSet,
		integer(intg), intent(in)	derivedType,
		integer(intg), intent(in)	fieldVariableType,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Sets the field variable type of the derived field to be used to store a derived variable.

See also: OPENCMISS::CMISSEquationsSet_DerivedVariableSet

Parameters

[in]	equationsset	A pointer to the equations set to calculate a derived field for
[in]	derivedtype	The derived value type to calculate.

See also: EQUATIONS_SET_CONSTANTS::DerivedTypes.

Parameters

[in]	fieldvariabletype	The field variable type used to store the calculated derived value
[out]	err	The error code
[out]	error	The error string

Definition at line 6197 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equationsset_equationssetfieldinitialise	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises the equations set field for a equations set.

Parameters

	equations_set	A pointer to the equations set to initialise the dependent field for
[out]	err	The error code
[out]	error	The error string

Definition at line 4487 of file equations_set_routines.f90.

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

Referenced by equations_set_initialise().

subroutine equations_set_routines::equationsset_finiteelementjacobianevaluate	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	ELEMENT_NUMBER,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Evaluates the element Jacobian for the given element number for a finite element equations set.

Parameters

	equations_set	A pointer to the equations set
[in]	element_number	The element number to evaluate the Jacobian for
[out]	err	The error code
[out]	error	The error string

Definition at line 2918 of file equations_set_routines.f90.

References classical_field_routines::classicalfield_finiteelementjacobianevaluate(), elasticity_routines::elasticity_finite_element_jacobian_evaluate(), base_routines::enters(), equations_routines::equations_element_matrix_output, equations_matrices_routines::equations_jacobian_analytic_calculated, equations_matrices_routines::equations_jacobian_finite_difference_calculated, equations_set_constants::equations_set_bioelectrics_class, equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_elasticity_class, equations_set_constants::equations_set_electromagnetics_class, equations_set_constants::equations_set_fluid_mechanics_class, equations_set_constants::equations_set_modal_class, equations_set_constants::equations_set_multi_physics_class, equationsset_finiteelementjacobianevaluatefd(), base_routines::exits(), fluid_mechanics_routines::fluidmechanics_finiteelementjacobianevaluate(), base_routines::general_output_type, and input_output::write_string_matrix_name_and_indices.

Referenced by equations_set_jacobian_evaluate_dynamic_fem(), and equations_set_jacobian_evaluate_static_fem().

subroutine equations_set_routines::equationsset_finiteelementjacobianevaluatefd	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(in)	elementNumber,
		integer(intg), intent(in)	jacobianNumber,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Evaluates the element Jacobian matrix entries using finite differencing for a general finite element equations set.

Parameters

	equationsset	A pointer to the equations set to evaluate the element Jacobian for
[in]	elementnumber	The element number to calculate the Jacobian for
[in]	jacobiannumber	The Jacobian number to calculate when there are coupled problems
[out]	err	The error code
[out]	error	The error string

Definition at line 3039 of file equations_set_routines.f90.

References distributed_matrix_vector::distributedvector_l2norm(), base_routines::enters(), equationsset_finiteelementresidualevaluate(), base_routines::errors(), and base_routines::exits().

Referenced by equationsset_finiteelementjacobianevaluate().

subroutine equations_set_routines::equationsset_finiteelementresidualevaluate	(	type(equations_set_type), pointer	EQUATIONS_SET,
		integer(intg), intent(in)	ELEMENT_NUMBER,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Evaluates the element residual and rhs vector for the given element number for a finite element equations set.

Parameters

	equations_set	A pointer to the equations set
[in]	element_number	The element number to evaluate the residual for
[out]	err	The error code
[out]	error	The error string

Definition at line 3164 of file equations_set_routines.f90.

References classical_field_routines::classicalfield_finiteelementresidualevaluate(), elasticity_routines::elasticity_finite_element_residual_evaluate(), base_routines::enters(), equations_routines::equations_element_matrix_output, equations_set_constants::equations_set_bioelectrics_class, equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_elasticity_class, equations_set_constants::equations_set_electromagnetics_class, equations_set_constants::equations_set_fluid_mechanics_class, equations_set_constants::equations_set_modal_class, equations_set_constants::equations_set_multi_physics_class, base_routines::exits(), fluid_mechanics_routines::fluidmechanics_finiteelementresidualevaluate(), base_routines::general_output_type, and input_output::write_string_matrix_name_and_indices.

Referenced by equations_set_assemble_static_nonlinear_fem(), equations_set_residual_evaluate_dynamic_fem(), equations_set_residual_evaluate_static_fem(), and equationsset_finiteelementjacobianevaluatefd().

subroutine equations_set_routines::equationsset_jacobianevaluatestaticnodal	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Evaluates the Jacobian for an static equations set using the finite nodal method.

Parameters

	equationsset	A pointer to the equations set to evaluate the Jacobian for
[out]	err	The error code
[out]	error	The error string

Definition at line 7272 of file equations_set_routines.f90.

References timer::cpu_timer(), base_routines::enters(), equations_matrices_routines::equations_matrices_jacobian_only, equations_matrices_routines::equations_matrices_jacobian_output(), equations_matrices_routines::equations_matrices_values_initialise(), equations_routines::equations_matrix_output, equations_routines::equations_timing_output, equations_matrices_routines::equationsmatrices_jacobiannodeadd(), equations_matrices_routines::equationsmatrices_nodalcalculate(), equations_matrices_routines::equationsmatrices_nodalfinalise(), equations_matrices_routines::equationsmatrices_nodalinitialise(), equationsset_nodaljacobianevaluate(), base_routines::exits(), base_routines::general_output_type, timer::system_cpu, and timer::user_cpu.

Referenced by equations_set_jacobian_evaluate().

subroutine equations_set_routines::equationsset_nodaljacobianevaluate	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(in)	nodeNumber,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Evaluates the nodal Jacobian for the given node number for a nodal equations set.

Parameters

	equationsset	A pointer to the equations set
[in]	nodenumber	The node number to evaluate the Jacobian for
[out]	err	The error code
[out]	error	The error string

Definition at line 6996 of file equations_set_routines.f90.

References base_routines::enters(), equations_matrices_routines::equations_jacobian_analytic_calculated, equations_matrices_routines::equations_jacobian_finite_difference_calculated, equations_routines::equations_nodal_matrix_output, equations_set_constants::equations_set_bioelectrics_class, equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_elasticity_class, equations_set_constants::equations_set_electromagnetics_class, equations_set_constants::equations_set_fluid_mechanics_class, equations_set_constants::equations_set_modal_class, equations_set_constants::equations_set_multi_physics_class, base_routines::exits(), fluid_mechanics_routines::fluidmechanics_nodaljacobianevaluate(), base_routines::general_output_type, and input_output::write_string_matrix_name_and_indices.

Referenced by equationsset_jacobianevaluatestaticnodal().

subroutine equations_set_routines::equationsset_nodalresidualevaluate	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(in)	nodeNumber,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Evaluates the nodal residual and rhs vector for the given node number for a nodal equations set.

Parameters

	equationsset	A pointer to the equations set
[in]	nodenumber	The nodal number to evaluate the residual for
[out]	err	The error code
[out]	error	The error string

Definition at line 7116 of file equations_set_routines.f90.

References base_routines::enters(), equations_routines::equations_nodal_matrix_output, equations_set_constants::equations_set_bioelectrics_class, equations_set_constants::equations_set_classical_field_class, equations_set_constants::equations_set_elasticity_class, equations_set_constants::equations_set_electromagnetics_class, equations_set_constants::equations_set_fluid_mechanics_class, equations_set_constants::equations_set_modal_class, equations_set_constants::equations_set_multi_physics_class, base_routines::exits(), fluid_mechanics_routines::fluidmechanics_nodalresidualevaluate(), base_routines::general_output_type, and input_output::write_string_matrix_name_and_indices.

Referenced by equationsset_assemblestaticnonlinearnodal(), and equationsset_residualevaluatestaticnodal().

subroutine equations_set_routines::equationsset_residualevaluatestaticnodal	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Evaluates the residual for an static equations set using the nodal method.

Parameters

	equationsset	A pointer to the equations set to evaluate the residual for
[out]	err	The error code
[out]	error	The error string

Definition at line 7425 of file equations_set_routines.f90.

References timer::cpu_timer(), base_routines::enters(), equations_matrices_routines::equations_matrices_nonlinear_only, equations_matrices_routines::equations_matrices_output(), equations_matrices_routines::equations_matrices_values_initialise(), equations_routines::equations_matrix_output, equations_routines::equations_timing_output, equations_matrices_routines::equationsmatrices_nodalcalculate(), equations_matrices_routines::equationsmatrices_nodalfinalise(), equations_matrices_routines::equationsmatrices_nodalinitialise(), equations_matrices_routines::equationsmatrices_nodeadd(), equationsset_nodalresidualevaluate(), base_routines::exits(), base_routines::general_output_type, timer::system_cpu, and timer::user_cpu.

Referenced by equations_set_residual_evaluate().

subroutine, public equations_set_routines::equationsset_specificationget	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), dimension(:), intent(inout)	equationsSetSpecification,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Returns the equations set specification i.e., equations set class, type and subtype for an equations set.

See also: OPENCMISS::CMISSEquationsSetSpecificationGet

Parameters

	equationsset	A pointer to the equations set to get the specification for
[in,out]	equationssetspecification	On return, The equations set specifcation array. Must be allocated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 6055 of file equations_set_routines.f90.

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

subroutine equations_set_routines::equationsset_specificationset	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), dimension(:), intent(in)	specification,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

private

Sets/changes the equations set specification i.e., equations set class, type and subtype for an equations set.

See also: OPENCMISS::CMISSEquationsSetSpecificationSet

Parameters

	equationsset	A pointer to the equations set to set the specification for
[in]	specification	The equations set specification array to set
[out]	err	The error code
[out]	error	The error string

Definition at line 6252 of file equations_set_routines.f90.

Referenced by equations_set_create_start().

subroutine, public equations_set_routines::equationsset_specificationsizeget	(	type(equations_set_type), pointer	equationsSet,
		integer(intg), intent(out)	specificationSize,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Gets the size of the equations set specification array for a problem identified by a pointer.

See also: OPENCMISS::cmfe_EquationsSetSpecificationSizeGet

Parameters

	equationsset	A pointer to the equations Set to get the specification for.
[out]	specificationsize	On return, the size of the problem specifcation array.
[out]	err	The error code
[out]	error	The error string

Definition at line 6103 of file equations_set_routines.f90.

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

subroutine, public equations_set_routines::equationsset_tensorinterpolatexi	(	type(equations_set_type), intent(in), pointer	equationsSet,
		integer(intg), intent(in)	tensorEvaluateType,
		integer(intg), intent(in)	userElementNumber,
		real(dp), dimension(:), intent(in)	xi,
		real(dp), dimension(3,3), intent(out)	values,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Evaluate a tensor at a given element xi location.

Parameters

[in]	equationsset	A pointer to the equations set to interpolate the tensor for.
[in]	tensorevaluatetype	The type of tensor to evaluate.
[in]	userelementnumber	The user element number of the field to interpolate.
[in]	xi	The element xi to interpolate the field at.
[out]	values	The interpolated tensor values.
[out]	err	The error code.
[out]	error	The error string

Definition at line 6321 of file equations_set_routines.f90.

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation