OpenCMISSIron Internal API Documentation

This module handles all equations routines. More...
Go to the source code of this file.
Modules  
module  equations_routines 
This module handles all equations routines.  
Functions/Subroutines  
subroutine, public  equations_routines::equations_create_finish (EQUATIONS, ERR, ERROR,) 
Finish the creation of equations. More...  
subroutine, public  equations_routines::equations_create_start (EQUATIONS_SET, EQUATIONS, ERR, ERROR,) 
Start the creation of equations for the equation set. More...  
subroutine, public  equations_routines::equations_destroy (EQUATIONS, ERR, ERROR,) 
Destroys equations. More...  
subroutine, public  equations_routines::equations_finalise (EQUATIONS, ERR, ERROR,) 
Finalise the equations and deallocate all memory. More...  
subroutine, public  equations_routines::equations_initialise (EQUATIONS_SET, ERR, ERROR,) 
Initialises the equations for an equations set. More...  
subroutine  equations_routines::equations_interpolation_finalise (EQUATIONS_INTERPOLATION, ERR, ERROR,) 
Finalises the interpolation information for equations and deallocates all memory. More...  
subroutine  equations_routines::equations_interpolation_initialise (EQUATIONS, ERR, ERROR,) 
Initialises the interpolation information for equations. More...  
subroutine, public  equations_routines::equations_linearity_type_get (EQUATIONS, LINEARITY_TYPE, ERR, ERROR,) 
Gets the linearity type for equations. More...  
subroutine, public  equations_routines::equations_linearity_type_set (EQUATIONS, LINEARITY_TYPE, ERR, ERROR,) 
Sets/changes the linearity type for equations. More...  
subroutine, public  equations_routines::equations_lumping_type_get (EQUATIONS, LUMPING_TYPE, ERR, ERROR,) 
Gets the lumping type for equations. More...  
subroutine, public  equations_routines::equations_lumping_type_set (EQUATIONS, LUMPING_TYPE, ERR, ERROR,) 
Sets/changes the matrix lumping for the equations. More...  
subroutine, public  equations_routines::equations_output_type_get (EQUATIONS, OUTPUT_TYPE, ERR, ERROR,) 
Gets the output type for equations. More...  
subroutine, public  equations_routines::equations_output_type_set (EQUATIONS, OUTPUT_TYPE, ERR, ERROR,) 
Sets/changes the output type for the equations. More...  
subroutine, public  equations_routines::equations_sparsity_type_get (EQUATIONS, SPARSITY_TYPE, ERR, ERROR,) 
Gets the sparsity type for equations. More...  
subroutine, public  equations_routines::equations_sparsity_type_set (EQUATIONS, SPARSITY_TYPE, ERR, ERROR,) 
Sets/changes the sparsity type for the equations. More...  
subroutine, public  equations_routines::equations_time_dependence_type_get (EQUATIONS, TIME_DEPENDENCE_TYPE, ERR, ERROR,) 
Gets the time dependence type for equations. More...  
subroutine, public  equations_routines::equations_time_dependence_type_set (EQUATIONS, TIME_DEPENDENCE_TYPE, ERR, ERROR,) 
Sets/changes the time dependence type for equations. More...  
subroutine, public  equations_routines::equations_set_equations_get (EQUATIONS_SET, EQUATIONS, ERR, ERROR,) 
Gets the equations for an equations set. More...  
subroutine, public  equations_routines::equations_derivedvariableget (equations, derivedType, fieldVariable, err, error,) 
Gets the field variable for the derived variable type. More...  
subroutine, public  equations_routines::equations_numberoflinearmatricesget (equations, numberOfMatrices, err, error,) 
Get the number of linear matrices in the equations. More...  
subroutine, public  equations_routines::equations_numberofjacobianmatricesget (equations, numberOfMatrices, err, error,) 
Get the number of Jacobian matrices in the equations. More...  
subroutine, public  equations_routines::equations_numberofdynamicmatricesget (equations, numberOfMatrices, err, error,) 
Get the number of dynamic matrices in the equations. More...  
subroutine, public  equations_routines::equations_linearmatrixget (equations, matrixIndex, matrix, err, error,) 
Get a linear equations matrix from equations. More...  
subroutine, public  equations_routines::equations_jacobianmatrixget (equations, residualIndex, variableType, matrix, err, error,) 
Get a Jacobian matrix from equations. More...  
subroutine, public  equations_routines::equations_dynamicmatrixget (equations, matrixIndex, matrix, err, error,) 
Get a dynamic equations matrix from equations using the dynamic matrix index. More...  
subroutine, public  equations_routines::equations_dynamicmatrixgetbytype (equations, matrixType, matrix, err, error,) 
Get a dynamic equations matrix from equations using the dynamic matrix type. More...  
subroutine, public  equations_routines::equations_dynamicmatrixtypeget (equations, matrixIndex, matrixType, err, error,) 
Get the type of a dynamic matrix, eg. stiffness, damping or mass. More...  
subroutine, public  equations_routines::equations_rhsvectorget (equations, vector, err, error,) 
Get the right hand side vector for equations. More...  
subroutine, public  equations_routines::equations_residualvectorget (equations, residualIndex, vector, err, error,) 
Get a residual vector for nonlinear equations. More...  
subroutine, public  equations_routines::equations_residualnumberofvariablesget (equations, residualIndex, numberOfVariables, err, error,) 
Get the number of field variables that contribute to the residual vector. More...  
subroutine, public  equations_routines::equations_residualvariablesget (equations, residualIndex, residualVariables, err, error,) 
Get the field variables that contribute to the residual vector. More...  
subroutine, public  equations_routines::equations_sourcevectorget (equations, vector, err, error,) 
Get the source vector for equations. More...  
Variables  
integer(intg), parameter, public  equations_routines::equations_no_output =0 
No output. More...  
integer(intg), parameter, public  equations_routines::equations_timing_output =1 
Timing information output. More...  
integer(intg), parameter, public  equations_routines::equations_matrix_output =2 
All below and equation matrices output. More...  
integer(intg), parameter, public  equations_routines::equations_element_matrix_output =3 
All below and element matrices output. More...  
integer(intg), parameter, public  equations_routines::equations_nodal_matrix_output =4 
All below and nodal matrices output. More...  
integer(intg), parameter, public  equations_routines::equations_sparse_matrices =1 
Use sparse matrices for the equations. More...  
integer(intg), parameter, public  equations_routines::equations_full_matrices =2 
Use fully populated matrices for the equations. More...  
integer(intg), parameter, public  equations_routines::equations_unlumped_matrices =1 
The equations matrices are not lumped. More...  
integer(intg), parameter, public  equations_routines::equations_lumped_matrices =2 
The equations matrices are "mass" lumped. More...  
This module handles all equations routines.
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) 20072010 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_routines.f90.