OpenCMISS-Iron Internal API Documentation
solver_mapping_routines.f90 File Reference

This module handles all solver mapping routines. More...

Go to the source code of this file.

Modules

module  solver_mapping_routines
 This module handles all solver mapping routines.
 

Functions/Subroutines

subroutine solver_mapping_routines::solver_mapping_calculate (SOLVER_MAPPING, ERR, ERROR,)
 Calculates the solver mappings. More...
 
subroutine, public solver_mapping_routines::solver_mapping_create_finish (SOLVER_MAPPING, ERR, ERROR,)
 Finishes the process of creating a solver mapping. More...
 
subroutine, public solver_mapping_routines::solver_mapping_create_start (SOLVER_EQUATIONS, SOLVER_MAPPING, ERR, ERROR,)
 Finishes the process of creating a solver mapping for a problem solver. More...
 
subroutine solver_mapping_routines::solver_mapping_create_values_cache_finalise (CREATE_VALUES_CACHE, ERR, ERROR,)
 Finalises a solver mapping create values cache and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_createvaluescacheinitialise (SOLVER_MAPPING, ERR, ERROR,)
 Initialises a solver mapping create values cache. More...
 
subroutine solver_mapping_routines::solvermapping_createvaluescacheeqnvarlistadd (SOLVER_MAPPING, solver_matrix_idx, equations_set_idx, variable_type, ERR, ERROR,)
 Adds a variable type from an equations set dependent field to the list of variables for a particular solver matrix of a solver mapping. More...
 
subroutine solver_mapping_routines::solvermapping_createvaluescacheinterfvarlistadd (SOLVER_MAPPING, solver_matrix_idx, interface_condition_idx, variable_type, ERR, ERROR,)
 Adds a variable type from an interface condition Lagrange field to the list of variables for a particular solver matrix of a solver mapping. More...
 
subroutine, public solver_mapping_routines::solver_mapping_destroy (SOLVER_MAPPING, ERR, ERROR,)
 Destroy a solver mapping. More...
 
subroutine solver_mapping_routines::solvermapping_equatscoltosolcolsmapfinalise (EQUATIONS_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Finalises a equations column to solver columns map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equatscoltosolcolsmapinitialise (EQUATIONS_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Initialises an equations column to solver columns map. More...
 
subroutine, public solver_mapping_routines::solvermapping_equatsvarstosolvermatrixset (SOLVER_MAPPING, SOLVER_MATRIX, EQUATIONS_SET_INDEX, VARIABLE_TYPES, ERR, ERROR,)
 Sets/changes the mapping of global variables to a solver matrix for the solver mapping. More...
 
subroutine solver_mapping_routines::solvermapping_equatsrowtosolrowsmapfinalise (EQUATIONS_ROW_SOLVER_ROWS_MAP, ERR, ERROR,)
 Finalises a equations row to solver rows map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equatsrowtosolrowsmapinitialise (EQUATIONS_ROW_SOLVER_ROWS_MAP, ERR, ERROR,)
 Initialises an equations row to solver rows map. More...
 
subroutine, public solver_mapping_routines::solver_mapping_equations_set_add (SOLVER_MAPPING, EQUATIONS_SET, EQUATIONS_SET_INDEX, ERR, ERROR,)
 Adds an equations set to a solver mapping. More...
 
subroutine solver_mapping_routines::solvermapping_equationssettosolvermapfinalise (EQUATIONS_SET_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a equations set to solver map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equationssettosolvermapinitialise (EQUATIONS_SET_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises a equations set to solver map. More...
 
subroutine solver_mapping_routines::solvermapping_equationstosolvermapsfinalise (EQUATIONS_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a equations set to solver matrix map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equationstosolvermapsinitialise (EQUATIONS_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises an equations to solver maps. More...
 
subroutine solver_mapping_routines::solvermapping_equationstosolverinterfacefinalise (EQUATIONS_TO_SOLVER_INTERFACE_MAP, ERR, ERROR,)
 Finalises a equations set to solver matrix map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equationstosolverinterfaceinitialise (EQUATIONS_TO_SOLVER_INTERFACE_MAP, ERR, ERROR,)
 Initialises a equations set to solver matrix interface map. More...
 
subroutine solver_mapping_routines::solvermapping_equatstosolmatmapsemfinalise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_EM, ERR, ERROR,)
 Finalises a equations set to solver matrix map em and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equatstosolmatmapseminitialise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_EM, ERR, ERROR,)
 Initialises an equations to solver matrix maps em. More...
 
subroutine solver_mapping_routines::solvermapping_equatstosolmatmapsjmfinalise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_JM, ERR, ERROR,)
 Finalises a equations set to solver matrix map jm and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equatstosolmatmapssmfinalise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Finalises a equations set to solver matrix map sm and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_equatstosolmatmapssminitialise (EQUATIONS_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Initialises an equations to solver matrix maps sm. More...
 
subroutine solver_mapping_routines::solver_mapping_finalise (SOLVER_MAPPING, ERR, ERROR,)
 Finalises the solver mapping and deallocates all memory. More...
 
subroutine solver_mapping_routines::solver_mapping_initialise (SOLVER_EQUATIONS, ERR, ERROR,)
 Initialises the solver mapping and deallocates all memory. More...
 
subroutine, public solver_mapping_routines::solver_mapping_interface_condition_add (SOLVER_MAPPING, INTERFACE_CONDITION, INTERFACE_CONDITION_INDEX, ERR, ERROR,)
 Adds an interface condition to a solver mapping. More...
 
subroutine solver_mapping_routines::solvermapping_interfconditiontosolvermapfinalise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises an interface condition to solver map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interfconditiontosolvermapinitialise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises an interface condition to solver map. More...
 
subroutine solver_mapping_routines::solvermapping_interfacetosolvermapfinalise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a interface condition to solver map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interfacetosolvermapinitialise (INTERFACE_CONDITION_TO_SOLVER_MAP, ERR, ERROR,)
 Initialises an interface condition to solver map. More...
 
subroutine solver_mapping_routines::solvermapping_interfacetosolvermapsfinalise (INTERFACE_TO_SOLVER_MAPS, ERR, ERROR,)
 Finalises an interface to solver matrix maps and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interfacetosolvermapsinitialise (INTERFACE_TO_SOLVER_MAPS, ERR, ERROR,)
 Initialises an interface to solver maps. More...
 
subroutine solver_mapping_routines::solvermapping_interfacetosolverequationsfinalise (INTERFACE_TO_SOLVER_EQUATIONS_MAPS, ERR, ERROR,)
 Finalises an interface to solver matrix equations map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interfacetosolverequationsinitialise (INTERFACE_TO_SOLVER_EQUATIONS_MAPS, ERR, ERROR,)
 Initialises an interface to solver matrix equations map. More...
 
subroutine solver_mapping_routines::solvermapping_interfcoltosolrowsmapfinalise (INTERFACE_COLUMN_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Finalises a interface column to solver row map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interfcoltosolrowsmapinitialise (INTERFACE_COLUMN_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Initialises am interface column to solver row map. More...
 
subroutine solver_mapping_routines::solvermapping_interfrowtosolrowsmapfinalise (INTERFACE_ROW_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Finalises a interface row to solver row map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interfrowtosolrowsmapinitialise (INTERFACE_ROW_TO_SOLVER_ROWS_MAP, ERR, ERROR,)
 Initialises am interface row to solver row map. More...
 
subroutine solver_mapping_routines::solvermapping_interftosolmatmapsimfinalise (INTERFACE_TO_SOLVER_MATRIX_MAPS_IM, ERR, ERROR,)
 Finalises an interface to solver matrix map im and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interftosolmatmapsiminitialise (INTERFACE_TO_SOLVER_MATRIX_MAPS_IM, ERR, ERROR,)
 Initialises an interface to solver matrix maps im. More...
 
subroutine solver_mapping_routines::solvermapping_interftosolmatmapssmfinalise (INTERFACE_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Finalises an interface to solver matrix map sm and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_interftosolmatmapssminitialise (INTERFACE_TO_SOLVER_MATRIX_MAPS_SM, ERR, ERROR,)
 Initialises an interface to solver matrix maps sm. More...
 
subroutine solver_mapping_routines::solvermapping_jaccoltosolcolsmapfinalise (JACOBIAN_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Finalises a Jacobian column to solver columns map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_jaccoltosolcolsmapinitialise (JACOBIAN_COL_TO_SOLVER_COLS_MAP, ERR, ERROR,)
 Initialises an Jacobian column to solver columns map. More...
 
subroutine solver_mapping_routines::solvermapping_jacobiantosolvermapfinalise (JACOBIAN_TO_SOLVER_MAP, ERR, ERROR,)
 Finalises a equations set to solver matrix map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_jacobiantosolvermapinitialise (JACOBIAN_TO_SOLVER_MATRIX_MAP, ERR, ERROR,)
 Initialises a Jacobian to solver maps. More...
 
subroutine solver_mapping_routines::solvermapping_solvercoltodequationsmapfinalise (SOLVER_COL_TO_DYNAMIC_EQUATIONS_MAP, ERR, ERROR,)
 Finalises the solver column to dynamic equations map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solvercoltodequationsmapinitialise (SOLVER_COL_TO_DYNAMIC_EQUATIONS_MAP, ERR, ERROR,)
 Initialises the solver column to dynamic equations mapping and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solvercoltosequationsmapfinalise (SOLVER_COL_TO_STATIC_EQUATIONS_MAP, ERR, ERROR,)
 Finalises the solver column to static equations map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solvercoltosequationsmapinitialise (SOLVER_COL_TO_STATIC_EQUATIONS_MAP, ERR, ERROR,)
 Initialises the solver column to static equations mapping and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltoequatssetmapfinalise (SOLVER_COL_TO_EQUATIONS_SET_MAP, ERR, ERROR,)
 Finalises the solver column to equations set map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltoequatssetmapinitialise (SOLVER_COL_TO_EQUATIONS_SET_MAP, ERR, ERROR,)
 Initialises the solver column to equations set mapping and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltoequationsmapsfinalise (SOLVER_COL_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Finalises the solver column to equations map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltoequationsmapsinitialise (SOLVER_COL_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Initialises the solver column to equations mapping and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltointerfmapfinalise (SOLVER_COL_TO_INTERFACE_MAP, ERR, ERROR,)
 Finalises the solver column to interface map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltointerfmapinitialise (SOLVER_COL_TO_INTERFACE_MAP, ERR, ERROR,)
 Initialises the solver column to interface mapping. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltointerfequatsmapfinalise (SOLVER_COL_TO_INTERFACE_EQUATIONS_MAP, ERR, ERROR,)
 Finalises the solver column to interface equations map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solcoltointerfequatsmapinitialise (SOLVER_COL_TO_INTERFACE_EQUATIONS_MAP, ERR, ERROR,)
 Initialises the solver column to interface equations mapping. More...
 
subroutine solver_mapping_routines::solvermapping_solverdoftovariablemapfinalise (SOLVER_DOF_TO_VARIABLE_MAP, ERR, ERROR,)
 Finalises the solver dof to variable mapping and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solverdoftovariablemapinitialise (SOLVER_DOF_TO_VARIABLE_MAP, ERR, ERROR,)
 Initialises the solver dof to variable mapping. More...
 
subroutine, public solver_mapping_routines::solver_mapping_solver_matrices_number_set (SOLVER_MAPPING, NUMBER_OF_SOLVER_MATRICES, ERR, ERROR,)
 Sets/changes the number of solver matrices for the solver mapping. More...
 
subroutine solver_mapping_routines::solvermapping_solrowtoequationsmapsfinalise (SOLVER_ROW_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Finalises a solver row to equations map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_solrowtoequationsmapsinitialise (SOLVER_ROW_TO_EQUATIONS_MAPS, ERR, ERROR,)
 Initialises a solver row to equations map. More...
 
subroutine solver_mapping_routines::solver_mapping_variable_finalise (SOLVER_MAPPING_VARIABLE, ERR, ERROR,)
 Finalises the solver mapping variable and deallocates all memory. More...
 
subroutine solver_mapping_routines::solver_mapping_variable_initialise (SOLVER_MAPPING_VARIABLE, ERR, ERROR,)
 Initialises the solver mapping and deallocates all memory. More...
 
subroutine solver_mapping_routines::solver_mapping_variables_finalise (SOLVER_MAPPING_VARIABLES, ERR, ERROR,)
 Finalises the solver mapping variables and deallocates all memory. More...
 
subroutine solver_mapping_routines::solver_mapping_variables_initialise (SOLVER_MAPPING_VARIABLES, ERR, ERROR,)
 Initialises the solver mapping variables and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_variabletosolvercolmapfinalise (VARIABLE_TO_SOLVER_COL_MAP, ERR, ERROR,)
 Finalises a variable to solver column map and deallocates all memory. More...
 
subroutine solver_mapping_routines::solvermapping_variabletosolvercolmapinitialise (VARIABLE_TO_SOLVER_COL_MAP, ERR, ERROR,)
 Initialises a variable to solver column map. More...
 
subroutine solver_mapping_routines::solverdofcouplings_addcoupling (solverDofCouplings, coupling, couplingIndex, err, error,)
 Add a new DOF coupling to the list of global solver couplings. More...
 
subroutine solver_mapping_routines::solverdofcouplings_finalise (solverDofCouplings, err, error,)
 Initialise the list of solver row or column couplings. More...
 
subroutine solver_mapping_routines::solverdofcouplings_initialise (solverDofCouplings, err, error,)
 Initialise the list of solver row or column couplings. More...
 

Variables

integer(intg), parameter, public solver_mapping_routines::solver_mapping_equations_dynamic_matrix =1
 The equations matrix in the solver mapping is a dynamic equations matrix. More...
 
integer(intg), parameter, public solver_mapping_routines::solver_mapping_equations_linear_matrix =2
 The equations matrix in the solver mapping is a linear equations matrix. More...
 
integer(intg), parameter solver_mapping_routines::solver_mapping_equations_nonlinear_matrix =3
 The equations matrix in the solver mapping is a nonlinear equations (Jacobian) matrix. More...
 
integer(intg), parameter, public solver_mapping_routines::solver_mapping_equations_equations_set =1
 The equations in the solver mapping is from an equations set. More...
 
integer(intg), parameter, public solver_mapping_routines::solver_mapping_equations_interface_condition =2
 The equations in the solver mapping is from an interface condition. More...
 
integer(intg), parameter solver_mapping_routines::solver_mapping_equations_interface_transpose =3
 The equations in the solver mapping is from a transposed interface condition. More...
 

Detailed Description

This module handles all solver mapping 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 solver_mapping_routines.f90.