OpenCMISS-Iron Internal API Documentation
equations_set_routines.f90 File Reference

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

Go to the source code of this file.

Modules

module  equations_set_routines
 This module handles all equations set routines.
 

Functions/Subroutines

subroutine, public equations_set_routines::equations_set_analytic_create_finish (EQUATIONS_SET, ERR, ERROR,)
 Finish the creation of a analytic solution for equations set. More...
 
subroutine, public equations_set_routines::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_routines::equations_set_analytic_destroy (EQUATIONS_SET, ERR, ERROR,)
 Destroy the analytic solution for an equations set. More...
 
subroutine, public equations_set_routines::equations_set_analytic_evaluate (EQUATIONS_SET, ERR, ERROR,)
 Evaluates the current analytic solution for an equations set. More...
 
subroutine equations_set_routines::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_routines::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_routines::equations_set_analytic_initialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises the analytic solution for an equations set. More...
 
subroutine, public equations_set_routines::equations_set_analytic_time_get (EQUATIONS_SET, TIME, ERR, ERROR,)
 Returns the analytic time for an equations set. More...
 
subroutine, public equations_set_routines::equations_set_analytic_time_set (EQUATIONS_SET, TIME, ERR, ERROR,)
 Sets/changes the analytic time for an equations set. More...
 
subroutine, public equations_set_routines::equations_set_analytic_user_param_set (EQUATIONS_SET, PARAM_IDX, PARAM, ERR, ERROR,)
 Sets the analytic problem user parameter. More...
 
subroutine, public equations_set_routines::equations_set_analytic_user_param_get (EQUATIONS_SET, PARAM_IDX, PARAM, ERR, ERROR,)
 Sets the analytic problem user parameter. More...
 
subroutine, public equations_set_routines::equations_set_assemble (EQUATIONS_SET, ERR, ERROR,)
 Assembles the equations for an equations set. More...
 
subroutine equations_set_routines::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_routines::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_routines::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 equations_set_routines::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 equations_set_routines::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_routines::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_routines::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_routines::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_routines::equations_set_create_finish (EQUATIONS_SET, ERR, ERROR,)
 Finishes the process of creating an equation set on a region. More...
 
subroutine, public equations_set_routines::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_routines::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_routines::equations_set_destroy (EQUATIONS_SET, ERR, ERROR,)
 Destroys an equations set identified by a pointer and deallocates all memory. More...
 
subroutine equations_set_routines::equations_set_finalise (EQUATIONS_SET, ERR, ERROR,)
 Finalise the equations set and deallocate all memory. More...
 
subroutine equations_set_routines::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 equations_set_routines::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 equations_set_routines::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 equations_set_routines::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_routines::equations_set_independent_create_finish (EQUATIONS_SET, ERR, ERROR,)
 Finish the creation of independent variables for an equations set. More...
 
subroutine, public equations_set_routines::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_routines::equations_set_independent_destroy (EQUATIONS_SET, ERR, ERROR,)
 Destroy the independent field for an equations set. More...
 
subroutine equations_set_routines::equations_set_independent_finalise (EQUATIONS_SET_INDEPENDENT, ERR, ERROR,)
 Finalise the independent field for an equations set. More...
 
subroutine equations_set_routines::equations_set_independent_initialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises the independent field for an equations set. More...
 
subroutine equations_set_routines::equations_set_initialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises an equations set. More...
 
subroutine equations_set_routines::equations_set_geometry_finalise (EQUATIONS_SET_GEOMETRY, ERR, ERROR,)
 Finalise the geometry for an equations set. More...
 
subroutine equations_set_routines::equations_set_geometry_initialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises the geometry for an equation set. More...
 
subroutine, public equations_set_routines::equations_set_materials_create_finish (EQUATIONS_SET, ERR, ERROR,)
 Finish the creation of materials for an equations set. More...
 
subroutine, public equations_set_routines::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_routines::equations_set_materials_destroy (EQUATIONS_SET, ERR, ERROR,)
 Destroy the materials for an equations set. More...
 
subroutine equations_set_routines::equations_set_materials_finalise (EQUATIONS_SET_MATERIALS, ERR, ERROR,)
 Finalise the materials for an equations set. More...
 
subroutine equations_set_routines::equations_set_materials_initialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises the materials for an equations set. More...
 
subroutine, public equations_set_routines::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_routines::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_routines::equations_set_dependent_destroy (EQUATIONS_SET, ERR, ERROR,)
 Destroy the dependent variables for an equations set. More...
 
subroutine equations_set_routines::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_routines::equations_set_dependent_initialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises the dependent variables for a equations set. More...
 
subroutine, public equations_set_routines::equationsset_derivedcreatefinish (equationsSet, err, error,)
 Finish the creation of a derived variables field for an equations set. More...
 
subroutine, public equations_set_routines::equationsset_derivedcreatestart (equationsSet, derivedFieldUserNumber, derivedField, err, error,)
 Start the creation of derived variables field for an equations set. More...
 
subroutine, public equations_set_routines::equationsset_deriveddestroy (equationsSet, err, error,)
 Destroy the derived variables for an equations set. More...
 
subroutine equations_set_routines::equationsset_derivedfinalise (equationsSetDerived, err, error,)
 Finalises the derived variables for an equation set and deallocates all memory. More...
 
subroutine equations_set_routines::equationsset_derivedinitialise (equationsSet, err, error,)
 Initialises the derived variables for a equations set. More...
 
subroutine equations_set_routines::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 equations_set_routines::equationsset_equationssetfieldinitialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises the equations set field for a equations set. More...
 
subroutine equations_set_routines::equations_set_setup (EQUATIONS_SET, EQUATIONS_SET_SETUP_INFO, ERR, ERROR,)
 Sets up the specifices for an equation set. More...
 
subroutine, public equations_set_routines::equations_set_equations_create_finish (EQUATIONS_SET, ERR, ERROR,)
 Finish the creation of equations for the equations set. More...
 
subroutine, public equations_set_routines::equations_set_equations_create_start (EQUATIONS_SET, EQUATIONS, ERR, ERROR,)
 Start the creation of equations for the equation set. More...
 
subroutine, public equations_set_routines::equations_set_equations_destroy (EQUATIONS_SET, ERR, ERROR,)
 Destroy the equations for an equations set. More...
 
subroutine, public equations_set_routines::equations_set_jacobian_evaluate (EQUATIONS_SET, ERR, ERROR,)
 Evaluates the Jacobian for a nonlinear equations set. More...
 
subroutine equations_set_routines::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_routines::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_routines::equations_set_residual_evaluate (EQUATIONS_SET, ERR, ERROR,)
 Evaluates the residual for an equations set. More...
 
subroutine equations_set_routines::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_routines::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_routines::equations_set_setup_finalise (EQUATIONS_SET_SETUP_INFO, ERR, ERROR,)
 Finalises the equations set setup and deallocates all memory. More...
 
subroutine equations_set_routines::equations_set_setup_initialise (EQUATIONS_SET_SETUP_INFO, ERR, ERROR,)
 Initialise the equations set setup. More...
 
subroutine, public equations_set_routines::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_routines::equations_set_solution_method_get (EQUATIONS_SET, SOLUTION_METHOD, ERR, ERROR,)
 Returns the solution method for an equations set. More...
 
subroutine, public equations_set_routines::equations_set_source_create_finish (EQUATIONS_SET, ERR, ERROR,)
 Finish the creation of a source for an equation set. More...
 
subroutine, public equations_set_routines::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_routines::equations_set_source_destroy (EQUATIONS_SET, ERR, ERROR,)
 Destroy the source for an equations set. More...
 
subroutine equations_set_routines::equations_set_source_finalise (EQUATIONS_SET_SOURCE, ERR, ERROR,)
 Finalise the source for a equations set and deallocate all memory. More...
 
subroutine equations_set_routines::equations_set_source_initialise (EQUATIONS_SET, ERR, ERROR,)
 Initialises the source for an equations set. More...
 
subroutine, public equations_set_routines::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 equations_set_routines::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 equations_set_routines::equationsset_derivedvariablecalculate (equationsSet, derivedType, err, error,)
 Calculates a derived variable value for the equations set. More...
 
subroutine, public equations_set_routines::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 equations_set_routines::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 equations_set_routines::equationsset_tensorinterpolatexi (equationsSet, tensorEvaluateType, userElementNumber, xi, values, err, error,)
 Evaluate a tensor at a given element xi location. More...
 
subroutine, public equations_set_routines::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_set_routines::equations_sets_finalise (REGION, ERR, ERROR,)
 Finalises all equations sets on a region and deallocates all memory. More...
 
subroutine, public equations_set_routines::equations_sets_initialise (REGION, ERR, ERROR,)
 Intialises all equations sets on a region. More...
 
subroutine equations_set_routines::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_routines::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 equations_set_routines::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 equations_set_routines::equationsset_nodaljacobianevaluate (equationsSet, nodeNumber, err, error,)
 Evaluates the nodal Jacobian for the given node number for a nodal equations set. More...
 
subroutine equations_set_routines::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 equations_set_routines::equationsset_jacobianevaluatestaticnodal (equationsSet, err, error,)
 Evaluates the Jacobian for an static equations set using the finite nodal method. More...
 
subroutine equations_set_routines::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.

Author
Chris Bradley

LICENSE

Version: MPL 1.1/GPL 2.0/LGPL 2.1

The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The Original Code is OpenCMISS

The Initial Developer of the Original Code is University of Auckland, Auckland, New Zealand, the University of Oxford, Oxford, United Kingdom and King's College, London, United Kingdom. Portions created by the University of Auckland, the University of Oxford and King's College, London are Copyright (C) 2007-2010 by the University of Auckland, the University of Oxford and King's College, London. All Rights Reserved.

Contributor(s):

Alternatively, the contents of this file may be used under the terms of either the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the MPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the MPL, the GPL or the LGPL.

Definition in file equations_set_routines.f90.