OpenCMISS-Iron Internal API Documentation
elasticity_routines Module Reference

This module handles all elasticity class routines. More...

Functions/Subroutines

subroutine, public elasticity_equationssetspecificationset (equationsSet, specification, err, error,)
 Sets the problem specification for an elasticity equation set class. More...
 
subroutine, public elasticity_finite_element_calculate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Calculates the element stiffness matries and rhs vector for the given element number for an elasticity class finite element equation set. More...
 
subroutine, public elasticity_finite_element_jacobian_evaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Evaluates the Jacobian for the given element number for an elasticity class finite element equation set. More...
 
subroutine, public elasticity_finite_element_residual_evaluate (EQUATIONS_SET, ELEMENT_NUMBER, ERR, ERROR,)
 Evaluates the residual and rhs vector for the given element number for an elasticity class finite element equation set. More...
 
subroutine, public elasticity_finiteelementpreresidualevaluate (EQUATIONS_SET, ERR, ERROR,)
 Pre-evaluates the residual for an elasticity class finite element equation set. More...
 
subroutine, public elasticity_finiteelementpostresidualevaluate (EQUATIONS_SET, ERR, ERROR,)
 Post-evaluates the residual for an elasticity class finite element equation set. More...
 
subroutine, public elasticity_equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP, ERR, ERROR,)
 Sets up the equations set for an elasticity equations set class. More...
 
subroutine, public elasticity_equationssetsolutionmethodset (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
 Sets/changes the solution method for an elasticity equation set class. More...
 
subroutine, public elasticity_equationssetderivedvariablecalculate (equationsSet, derivedType, err, error,)
 Calculates a derived value for the elasticity equations set. More...
 
subroutine, public elasticity_tensorinterpolatexi (equationsSet, tensorEvaluateType, userElementNumber, xi, values, err, error,)
 Evaluate a tensor at a given element xi location. More...
 
subroutine, public elasticity_boundaryconditionsanalyticcalculate (EQUATIONS_SET, BOUNDARY_CONDITIONS, ERR, ERROR,)
 Sets the analytic boundary conditions for an elasticity equation set class. More...
 
subroutine, public elasticity_problemspecificationset (problem, problemSpecification, err, error,)
 Sets/changes the problem type and subtype for an elasticity problem class. More...
 
subroutine, public elasticity_problem_setup (PROBLEM, PROBLEM_SETUP, ERR, ERROR,)
 Sets up the problem for an elasticity problem class. More...
 
subroutine, public elasticity_pre_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,)
 Performs pre-solve actions for an elasticity problem class. More...
 
subroutine, public elasticity_post_solve (CONTROL_LOOP, SOLVER, ERR, ERROR,)
 Sets up the output type for an elasticity problem class. More...
 
subroutine, public elasticity_control_loop_pre_loop (CONTROL_LOOP, ERR, ERROR,)
 Executes before each loop of a control loop, ie before each time step for a time loop. More...
 
subroutine, public elasticity_controllooppostloop (controlLoop, err, error,)
 Executes after each loop of a control loop. More...
 
subroutine, public elasticity_load_increment_apply (EQUATIONS_SET, ITERATION_NUMBER, MAXIMUM_NUMBER_OF_ITERATIONS, ERR, ERROR,)
 Apply load increments for equations sets. More...
 

Detailed Description

This module handles all elasticity class routines.

Function/Subroutine Documentation

subroutine, public elasticity_routines::elasticity_boundaryconditionsanalyticcalculate ( 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 
)

Sets the analytic boundary conditions for an elasticity equation set class.

Parameters
equations_setA pointer to the equations set to set the solution method for
boundary_conditionsA pointer to the boundary conditionsn to set
[out]errThe error code
[out]errorThe error string

Definition at line 545 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::errors(), base_routines::exits(), finite_elasticity_routines::finiteelasticity_boundaryconditionsanalyticcalculate(), and linear_elasticity_routines::linearelasticity_boundaryconditionsanalyticcalculate().

Referenced by equations_set_routines::equations_set_boundary_conditions_analytic().

subroutine, public elasticity_routines::elasticity_control_loop_pre_loop ( type(control_loop_type), pointer  CONTROL_LOOP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public elasticity_routines::elasticity_controllooppostloop ( type(control_loop_type), pointer  controlLoop,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public elasticity_routines::elasticity_equations_set_setup ( type(equations_set_type), pointer  EQUATIONS_SET,
type(equations_set_setup_type), intent(inout)  EQUATIONS_SET_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the equations set for an elasticity equations set class.

Parameters
equations_setA pointer to the equations set
[in,out]equations_set_setupThe equations set setup information
[out]errThe error code
[out]errorThe error string

Definition at line 374 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), finite_elasticity_routines::finite_elasticity_equations_set_setup(), and linear_elasticity_routines::linear_elasticity_equations_set_setup().

Referenced by equations_set_routines::equations_set_setup().

subroutine, public elasticity_routines::elasticity_equationssetderivedvariablecalculate ( 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 value for the elasticity equations set.

See also
OPENCMISS::CMISSEquationsSet_DerivedCalculate
Parameters
[in]equationssetA pointer to the equations set to calculate the output for
[in]derivedtypeThe derived field type to calculate.
See also
EQUATIONS_SET_CONSTANTS::DerivedTypes.
Parameters
[out]errThe error code
[out]errorThe error string

Definition at line 463 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::errors(), base_routines::exits(), and finite_elasticity_routines::finiteelasticityequationsset_derivedvariablecalculate().

Referenced by equations_set_routines::equationsset_derivedvariablecalculate().

subroutine, public elasticity_routines::elasticity_equationssetsolutionmethodset ( 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 elasticity equation set class.

Parameters
equations_setA pointer to the equations set to set the solution method for
[in]solution_methodThe solution method to set
[out]errThe error code
[out]errorThe error string

Definition at line 418 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), finite_elasticity_routines::finiteelasticity_equationssetsolutionmethodset(), and linear_elasticity_routines::linearelasticity_equationssetsolutionmethodset().

Referenced by equations_set_routines::equations_set_solution_method_set().

subroutine, public elasticity_routines::elasticity_equationssetspecificationset ( type(equations_set_type), pointer  equationsSet,
integer(intg), dimension(:), intent(in)  specification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Sets the problem specification for an elasticity equation set class.

Parameters
equationssetA pointer to the equations set
[in]specificationThe equations specification to set
[out]errThe error code
[out]errorThe error string

Definition at line 109 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::errors(), base_routines::exits(), finite_elasticity_routines::finiteelasticity_equationssetspecificationset(), and linear_elasticity_routines::linearelasticity_equationssetspecificationset().

Referenced by equations_set_routines::equationsset_specificationset().

subroutine, public elasticity_routines::elasticity_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 
)

Calculates the element stiffness matries and rhs vector for the given element number for an elasticity class finite element equation set.

Parameters
equations_setA pointer to the equations set
[in]element_numberThe element number to calcualate
[out]errThe error code
[out]errorThe error string

Definition at line 153 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), and linear_elasticity_routines::linear_elasticity_finite_element_calculate().

Referenced by equations_set_routines::equations_set_finite_element_calculate().

subroutine, public elasticity_routines::elasticity_finite_element_jacobian_evaluate ( type(equations_set_type), pointer  EQUATIONS_SET,
integer(intg), intent(in)  ELEMENT_NUMBER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Evaluates the Jacobian for the given element number for an elasticity class finite element equation set.

Parameters
equations_setA pointer to the equations set
[in]element_numberThe element number to calcualate
[out]errThe error code
[out]errorThe error string

Definition at line 197 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), and finite_elasticity_routines::finiteelasticity_finiteelementjacobianevaluate().

Referenced by equations_set_routines::equationsset_finiteelementjacobianevaluate().

subroutine, public elasticity_routines::elasticity_finite_element_residual_evaluate ( type(equations_set_type), pointer  EQUATIONS_SET,
integer(intg), intent(in)  ELEMENT_NUMBER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Evaluates the residual and rhs vector for the given element number for an elasticity class finite element equation set.

Parameters
equations_setA pointer to the equations set
[in]element_numberThe element number to calcualate
[out]errThe error code
[out]errorThe error string

Definition at line 241 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), and finite_elasticity_routines::finiteelasticity_finiteelementresidualevaluate().

Referenced by equations_set_routines::equationsset_finiteelementresidualevaluate().

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

Post-evaluates the residual for an elasticity class finite element equation set.

Parameters
equations_setA pointer to the equations set
[out]errThe error code
[out]errorThe error string

Definition at line 329 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::errors(), base_routines::exits(), and finite_elasticity_routines::finiteelasticity_finiteelementpostresidualevaluate().

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

Pre-evaluates the residual for an elasticity class finite element equation set.

Parameters
equations_setA pointer to the equations set
[out]errThe error code
[out]errorThe error string

Definition at line 285 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), and finite_elasticity_routines::finiteelasticity_finiteelementpreresidualevaluate().

subroutine, public elasticity_routines::elasticity_load_increment_apply ( type(equations_set_type), pointer  EQUATIONS_SET,
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
[in]iteration_numberThe current load increment iteration index
[in]maximum_number_of_iterationsFinal index for load increment loop
[out]errThe error code
[out]errorThe error string

Definition at line 893 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, base_routines::exits(), and finite_elasticity_routines::finite_elasticity_load_increment_apply().

Referenced by equations_set_routines::equations_set_load_increment_apply().

subroutine, public elasticity_routines::elasticity_post_solve ( type(control_loop_type), pointer  CONTROL_LOOP,
type(solver_type), pointer  SOLVER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets up the output type for an elasticity problem class.

Parameters
control_loopA pointer to the control loop to solve.
solverA pointer to the solver
[out]errThe error code
[out]errorThe error string

Definition at line 736 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), finite_elasticity_routines::finite_elasticity_post_solve(), problem_constants::problem_finite_elasticity_contact_type, and problem_constants::problem_linear_elasticity_contact_type.

subroutine, public elasticity_routines::elasticity_pre_solve ( type(control_loop_type), pointer  CONTROL_LOOP,
type(solver_type), pointer  SOLVER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Performs pre-solve actions for an elasticity problem class.

Parameters
control_loopA pointer to the control loop to solve.
solverA pointer to the solver
[out]errThe error code
[out]errorThe error string

Definition at line 688 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), finite_elasticity_routines::finite_elasticity_pre_solve(), problem_constants::problem_finite_elasticity_contact_type, and problem_constants::problem_linear_elasticity_contact_type.

subroutine, public elasticity_routines::elasticity_problem_setup ( type(problem_type), pointer  PROBLEM,
type(problem_setup_type), intent(inout)  PROBLEM_SETUP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public elasticity_routines::elasticity_problemspecificationset ( type(problem_type), pointer  problem,
integer(intg), dimension(:), intent(in)  problemSpecification,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)
subroutine, public elasticity_routines::elasticity_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]equationssetA pointer to the equations set to interpolate the tensor for.
[in]tensorevaluatetypeThe type of tensor to evaluate.
[in]userelementnumberThe user element number of the field to interpolate.
[in]xiThe element xi to interpolate the field at.
[out]valuesThe interpolated tensor values.
[out]errThe error code.
[out]errorThe error string

Definition at line 506 of file elasticity_routines.f90.

References base_routines::enters(), equations_set_constants::equations_set_finite_elasticity_type, equations_set_constants::equations_set_linear_elasticity_type, base_routines::exits(), and finite_elasticity_routines::finiteelasticity_tensorinterpolatexi().

Referenced by equations_set_routines::equationsset_tensorinterpolatexi().