This module handles all equations routines. More...

Functions/Subroutines
subroutine, public	equations_create_finish (EQUATIONS, ERR, ERROR,)
	Finish the creation of equations. More...

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

subroutine, public	equations_destroy (EQUATIONS, ERR, ERROR,)
	Destroys equations. More...

subroutine, public	equations_finalise (EQUATIONS, ERR, ERROR,)
	Finalise the equations and deallocate all memory. More...

subroutine, public	equations_initialise (EQUATIONS_SET, ERR, ERROR,)
	Initialises the equations for an equations set. More...

subroutine	equations_interpolation_finalise (EQUATIONS_INTERPOLATION, ERR, ERROR,)
	Finalises the interpolation information for equations and deallocates all memory. More...

subroutine	equations_interpolation_initialise (EQUATIONS, ERR, ERROR,)
	Initialises the interpolation information for equations. More...

subroutine, public	equations_linearity_type_get (EQUATIONS, LINEARITY_TYPE, ERR, ERROR,)
	Gets the linearity type for equations. More...

subroutine, public	equations_linearity_type_set (EQUATIONS, LINEARITY_TYPE, ERR, ERROR,)
	Sets/changes the linearity type for equations. More...

subroutine, public	equations_lumping_type_get (EQUATIONS, LUMPING_TYPE, ERR, ERROR,)
	Gets the lumping type for equations. More...

subroutine, public	equations_lumping_type_set (EQUATIONS, LUMPING_TYPE, ERR, ERROR,)
	Sets/changes the matrix lumping for the equations. More...

subroutine, public	equations_output_type_get (EQUATIONS, OUTPUT_TYPE, ERR, ERROR,)
	Gets the output type for equations. More...

subroutine, public	equations_output_type_set (EQUATIONS, OUTPUT_TYPE, ERR, ERROR,)
	Sets/changes the output type for the equations. More...

subroutine, public	equations_sparsity_type_get (EQUATIONS, SPARSITY_TYPE, ERR, ERROR,)
	Gets the sparsity type for equations. More...

subroutine, public	equations_sparsity_type_set (EQUATIONS, SPARSITY_TYPE, ERR, ERROR,)
	Sets/changes the sparsity type for the equations. More...

subroutine, public	equations_time_dependence_type_get (EQUATIONS, TIME_DEPENDENCE_TYPE, ERR, ERROR,)
	Gets the time dependence type for equations. More...

subroutine, public	equations_time_dependence_type_set (EQUATIONS, TIME_DEPENDENCE_TYPE, ERR, ERROR,)
	Sets/changes the time dependence type for equations. More...

subroutine, public	equations_set_equations_get (EQUATIONS_SET, EQUATIONS, ERR, ERROR,)
	Gets the equations for an equations set. More...

subroutine, public	equations_derivedvariableget (equations, derivedType, fieldVariable, err, error,)
	Gets the field variable for the derived variable type. More...

subroutine, public	equations_numberoflinearmatricesget (equations, numberOfMatrices, err, error,)
	Get the number of linear matrices in the equations. More...

subroutine, public	equations_numberofjacobianmatricesget (equations, numberOfMatrices, err, error,)
	Get the number of Jacobian matrices in the equations. More...

subroutine, public	equations_numberofdynamicmatricesget (equations, numberOfMatrices, err, error,)
	Get the number of dynamic matrices in the equations. More...

subroutine, public	equations_linearmatrixget (equations, matrixIndex, matrix, err, error,)
	Get a linear equations matrix from equations. More...

subroutine, public	equations_jacobianmatrixget (equations, residualIndex, variableType, matrix, err, error,)
	Get a Jacobian matrix from equations. More...

subroutine, public	equations_dynamicmatrixget (equations, matrixIndex, matrix, err, error,)
	Get a dynamic equations matrix from equations using the dynamic matrix index. More...

subroutine, public	equations_dynamicmatrixgetbytype (equations, matrixType, matrix, err, error,)
	Get a dynamic equations matrix from equations using the dynamic matrix type. More...

subroutine, public	equations_dynamicmatrixtypeget (equations, matrixIndex, matrixType, err, error,)
	Get the type of a dynamic matrix, eg. stiffness, damping or mass. More...

subroutine, public	equations_rhsvectorget (equations, vector, err, error,)
	Get the right hand side vector for equations. More...

subroutine, public	equations_residualvectorget (equations, residualIndex, vector, err, error,)
	Get a residual vector for nonlinear equations. More...

subroutine, public	equations_residualnumberofvariablesget (equations, residualIndex, numberOfVariables, err, error,)
	Get the number of field variables that contribute to the residual vector. More...

subroutine, public	equations_residualvariablesget (equations, residualIndex, residualVariables, err, error,)
	Get the field variables that contribute to the residual vector. More...

subroutine, public	equations_sourcevectorget (equations, vector, err, error,)
	Get the source vector for equations. More...

Variables
integer(intg), parameter, public	equations_no_output =0
	No output. More...

integer(intg), parameter, public	equations_timing_output =1
	Timing information output. More...

integer(intg), parameter, public	equations_matrix_output =2
	All below and equation matrices output. More...

integer(intg), parameter, public	equations_element_matrix_output =3
	All below and element matrices output. More...

integer(intg), parameter, public	equations_nodal_matrix_output =4
	All below and nodal matrices output. More...

integer(intg), parameter, public	equations_sparse_matrices =1
	Use sparse matrices for the equations. More...

integer(intg), parameter, public	equations_full_matrices =2
	Use fully populated matrices for the equations. More...

integer(intg), parameter, public	equations_unlumped_matrices =1
	The equations matrices are not lumped. More...

integer(intg), parameter, public	equations_lumped_matrices =2
	The equations matrices are "mass" lumped. More...

Detailed Description

This module handles all equations routines.

Function/Subroutine Documentation

subroutine, public equations_routines::equations_create_finish	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finish the creation of equations.

Parameters

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

Definition at line 159 of file equations_routines.f90.

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

subroutine, public equations_routines::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.

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 192 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_derivedvariableget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	derivedType,
		type(field_variable_type), intent(inout), pointer	fieldVariable,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Gets the field variable for the derived variable type.

Parameters

[in]	equations	A pointer to the equations to get the field variable for.
[in]	derivedtype	The derived value type to get the field variable for.

See also: EQUATIONS_SET_CONSTANTS::DerivedTypes.

Parameters

[in,out]	fieldvariable	On return, the field variable for the derived variable type.
[out]	err	The error code
[out]	error	The error string

Definition at line 935 of file equations_routines.f90.

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

Referenced by finite_elasticity_routines::finiteelasticityequationsset_derivedvariablecalculate().

subroutine, public equations_routines::equations_destroy	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroys equations.

Parameters

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

Definition at line 232 of file equations_routines.f90.

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

Referenced by equations_set_routines::equations_set_finalise().

subroutine, public equations_routines::equations_dynamicmatrixget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	matrixIndex,
		type(distributed_matrix_type), intent(inout), pointer	matrix,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get a dynamic equations matrix from equations using the dynamic matrix index.

Parameters

[in]	equations	The equations to get the dynamic matrix for
[in]	matrixindex	The number of the dynamic matrix to get
[in,out]	matrix	On return, the requested dynamic matrix
[out]	error	The error message
[out]	err	The error code

Definition at line 1257 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_dynamicmatrixgetbytype	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	matrixType,
		type(distributed_matrix_type), intent(inout), pointer	matrix,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get a dynamic equations matrix from equations using the dynamic matrix type.

Parameters

[in]	equations	The equations to get the dynamic matrix for
[in]	matrixtype	The type of the dynamic matrix to get.

See also: EQUATIONS_SET_CONSTANTS:DynamicMatrixTypes,EQUATIONS_SET_CONSTANTS

Parameters

[in,out]	matrix	On return, the requested dynamic matrix
[out]	error	The error message
[out]	err	The error code

Definition at line 1314 of file equations_routines.f90.

References base_routines::enters(), equations_set_constants::equations_matrix_damping, equations_set_constants::equations_matrix_mass, equations_set_constants::equations_matrix_stiffness, and base_routines::exits().

subroutine, public equations_routines::equations_dynamicmatrixtypeget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	matrixIndex,
		integer(intg), intent(inout)	matrixType,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the type of a dynamic matrix, eg. stiffness, damping or mass.

Parameters

[in]	equations	The equations to get the dynamic matrix for
[in]	matrixindex	The number of the dynamic matrix to get
[in,out]	matrixtype	On return, the type of the dynamic matrix.

See also: EQUATIONS_MATRICES_ROUTINES_DynamicMatrixTypes,EQUATIONS_MATRICES_ROUTINES

Parameters

[out]	error	The error message
[out]	err	The error code

Definition at line 1397 of file equations_routines.f90.

References base_routines::enters(), equations_set_constants::equations_matrix_damping, equations_set_constants::equations_matrix_mass, equations_set_constants::equations_matrix_stiffness, and base_routines::exits().

subroutine, public equations_routines::equations_finalise	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finalise the equations and deallocate all memory.

Parameters

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

Definition at line 260 of file equations_routines.f90.

References base_routines::enters(), equations_interpolation_finalise(), equations_mapping_routines::equations_mapping_destroy(), equations_matrices_routines::equations_matrices_destroy(), and base_routines::exits().

Referenced by equations_destroy(), equations_initialise(), and equations_set_routines::equations_set_equations_destroy().

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

Initialises the equations for an equations set.

Parameters

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

Definition at line 288 of file equations_routines.f90.

References base_routines::enters(), equations_finalise(), equations_interpolation_initialise(), equations_set_constants::equations_linear, equations_no_output, equations_sparse_matrices, equations_set_constants::equations_static, equations_unlumped_matrices, and base_routines::exits().

Referenced by equations_create_start().

subroutine equations_routines::equations_interpolation_finalise	(	type(equations_interpolation_type), pointer	EQUATIONS_INTERPOLATION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises the interpolation information for equations and deallocates all memory.

Parameters

	equations_interpolation	A pointer to the equations interpolation to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 335 of file equations_routines.f90.

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

Referenced by equations_finalise(), and equations_interpolation_initialise().

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

private

Initialises the interpolation information for equations.

Parameters

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

Definition at line 377 of file equations_routines.f90.

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

Referenced by equations_initialise().

subroutine, public equations_routines::equations_jacobianmatrixget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	residualIndex,
		integer(intg), intent(in)	variableType,
		type(distributed_matrix_type), intent(inout), pointer	matrix,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get a Jacobian matrix from equations.

Parameters

[in]	equations	The equations to get the Jacobian matrix for
[in]	residualindex	The index of the residual vector to get the Jacobian matrix for
[in]	variabletype	The field variable type that the residual is differentiated with respect to for this Jacobian
[in,out]	matrix	On return, the requested Jacobian matrix
[out]	error	The error message
[out]	err	The error code

Definition at line 1185 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_linearity_type_get	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	LINEARITY_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Gets the linearity type for equations.

Parameters

	equations	A pointer to the equations to get the linearity for
[out]	linearity_type	On exit, the linearity type of the equations.

See also: EQUATIONS_SET_CONSTANTS::LinearityTypes,EQUATIONS_SET_CONSTANTS

Parameters

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

Definition at line 507 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_linearity_type_set	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(in)	LINEARITY_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the linearity type for equations.

Parameters

	equations	A pointer to the equations to set the linearity for
[in]	linearity_type	The linearity type to set

See also: EQUATIONS_SET_CONSTANTS::LinearityTypes,EQUATIONS_SET_CONSTANTS

Parameters

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

Definition at line 539 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_linearmatrixget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	matrixIndex,
		type(distributed_matrix_type), intent(inout), pointer	matrix,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get a linear equations matrix from equations.

Parameters

[in]	equations	The equations to get the linear matrix for
[in]	matrixindex	The index of the linear matrix to get
[in,out]	matrix	On return, the linear matrix requested
[out]	error	The error message
[out]	err	The error code

Definition at line 1128 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_lumping_type_get	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	LUMPING_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Gets the lumping type for equations.

Parameters

	equations	A pointer to the equations to get the lumping type for
[out]	lumping_type	On exit, the lumping type of the equations
[out]	err	The error code
[out]	error	The error string

Definition at line 583 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_lumping_type_set	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(in)	LUMPING_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the matrix lumping for the equations.

Parameters

	equations	A pointer to the equations to set the lumping for
[in]	lumping_type	The lumping type to set

See also: EQUATIONS_ROUTINES::LumpingTypes,EQUATIONS_ROUTINES

Parameters

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

Definition at line 615 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_numberofdynamicmatricesget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(out)	numberOfMatrices,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the number of dynamic matrices in the equations.

Parameters

[in]	equations	The equations to get the number of dynamic matrices for
[out]	numberofmatrices	On return, the number of dynamic matrices
[out]	error	The error message
[out]	err	The error code

Definition at line 1087 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_numberofjacobianmatricesget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(out)	numberOfMatrices,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the number of Jacobian matrices in the equations.

Parameters

[in]	equations	The equations to get the number of Jacobian matrices for
[out]	numberofmatrices	On return, the number of Jacobian matrices
[out]	error	The error message
[out]	err	The error code

Definition at line 1046 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_numberoflinearmatricesget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(out)	numberOfMatrices,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the number of linear matrices in the equations.

Parameters

[in]	equations	The equations to get the number of linear matrices for
[out]	numberofmatrices	On return, the number of linear matrices
[out]	error	The error message
[out]	err	The error code

Definition at line 1005 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_output_type_get	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	OUTPUT_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Gets the output type for equations.

Parameters

	equations	A pointer to the equations to get the output type for
[out]	output_type	On exit, the output type of the equations
[out]	err	The error code
[out]	error	The error string

Definition at line 665 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_output_type_set	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(in)	OUTPUT_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the output type for the equations.

Parameters

	equations	A pointer to the equations to set the output type for
[in]	output_type	The output type to set

See also: EQUATIONS_ROUTINES::OutputTypes,EQUATIONS_ROUTINES

Parameters

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

Definition at line 697 of file equations_routines.f90.

References base_routines::enters(), equations_element_matrix_output, equations_matrix_output, equations_no_output, equations_nodal_matrix_output, equations_timing_output, and base_routines::exits().

subroutine, public equations_routines::equations_residualnumberofvariablesget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	residualIndex,
		integer(intg), intent(out)	numberOfVariables,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the number of field variables that contribute to the residual vector.

Parameters

[in]	equations	The equations to get the residual vector number of variables for
[in]	residualindex	The index of the residual vector to get the number of variables for
[out]	numberofvariables	On return, the number of variables that contribute to the residual vector
[out]	error	The error message
[out]	err	The error code

Definition at line 1547 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_residualvariablesget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	residualIndex,
		integer(intg), dimension(:), intent(out)	residualVariables,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the field variables that contribute to the residual vector.

Parameters

[in]	equations	The equations to get the residual vector variables for
[in]	residualindex	The index of the residual vector to get the variables for
[out]	residualvariables	residualVariables(varIdx). On return, the field variable type for the varIdx'th residual variable
[out]	error	The error message
[out]	err	The error code

Definition at line 1594 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_residualvectorget	(	type(equations_type), intent(in), pointer	equations,
		integer(intg), intent(in)	residualIndex,
		type(distributed_vector_type), intent(inout), pointer	vector,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get a residual vector for nonlinear equations.

Parameters

[in]	equations	The equations to get the residual vector for
[in]	residualindex	The index of the residual vector to get
[in,out]	vector	On return, the residual vector for the equations
[out]	error	The error message
[out]	err	The error code

Definition at line 1497 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_rhsvectorget	(	type(equations_type), intent(in), pointer	equations,
		type(distributed_vector_type), intent(inout), pointer	vector,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the right hand side vector for equations.

Parameters

[in]	equations	The equations to get the right hand side vector for
[in,out]	vector	On return, the right hand side vector for the equations
[out]	error	The error message
[out]	err	The error code

Definition at line 1452 of file equations_routines.f90.

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

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

Gets the equations for an equations set.

Parameters

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

Definition at line 897 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_sourcevectorget	(	type(equations_type), intent(in), pointer	equations,
		type(distributed_vector_type), intent(inout), pointer	vector,
		integer(intg), intent(out)	err,
		type(varying_string), intent(out)	error
	)

Get the source vector for equations.

Parameters

[in]	equations	The equations to get the source vector for
[in,out]	vector	On return, the source vector for the equations
[out]	error	The error message
[out]	err	The error code

Definition at line 1650 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_sparsity_type_get	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	SPARSITY_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Gets the sparsity type for equations.

Parameters

	equations	A pointer to the equations to get the output type for
[out]	sparsity_type	On exit, the sparsity type of the equations
[out]	err	The error code
[out]	error	The error string

Definition at line 745 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_sparsity_type_set	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(in)	SPARSITY_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the sparsity type for the equations.

Parameters

	equations	A pointer to the equations to set the sparsity type for
[in]	sparsity_type	The sparsity type to set

See also: EQUATIONS_ROUTINES::SparsityTypes,EQUATIONS_ROUTINES

Parameters

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

Definition at line 777 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_time_dependence_type_get	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(out)	TIME_DEPENDENCE_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Gets the time dependence type for equations.

Parameters

	equations	A pointer to the equations to get the output type for
[out]	time_dependence_type	On exit, the time dependence type of the equations
[out]	err	The error code
[out]	error	The error string

Definition at line 819 of file equations_routines.f90.

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

subroutine, public equations_routines::equations_time_dependence_type_set	(	type(equations_type), pointer	EQUATIONS,
		integer(intg), intent(in)	TIME_DEPENDENCE_TYPE,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the time dependence type for equations.

Parameters

	equations	A pointer to the equations to set the linearity for
[in]	time_dependence_type	The time dependence type to set

See also: EQUATIONS_ROUTINES_TimeDependenceTypes,EQUATIONS_ROUTINES

Parameters

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

Definition at line 851 of file equations_routines.f90.

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

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation