OpenCMISS-Iron Internal API Documentation
solver_matrices_routines.f90 File Reference

This module handles all solver matrix and rhs routines. More...

Go to the source code of this file.

Modules

module  solver_matrices_routines
 This module handles all solver matrix and rhs routines.
 

Functions/Subroutines

subroutine, public solver_matrices_routines::solver_matrices_create_finish (SOLVER_MATRICES, ERR, ERROR,)
 Finishes the process of creating the solver matrices. More...
 
subroutine, public solver_matrices_routines::solver_matrices_create_start (SOLVER_EQUATIONS, SOLVER_MATRICES, ERR, ERROR,)
 Starts the process of creating the solver matrices. More...
 
subroutine, public solver_matrices_routines::solver_matrices_destroy (SOLVER_MATRICES, ERR, ERROR,)
 Destroy the solver matrices. More...
 
subroutine solver_matrices_routines::solver_matrices_finalise (SOLVER_MATRICES, ERR, ERROR,)
 Finalises the solver matrices and deallocates all memory. More...
 
subroutine solver_matrices_routines::solver_matrices_initialise (SOLVER_EQUATIONS, ERR, ERROR,)
 Initialises the solver matrices for solver equations. More...
 
subroutine solver_matrices_routines::solver_matrices_library_type_get (SOLVER_MATRICES, LIBRARY_TYPE, ERR, ERROR,)
 Gets the library type for the solver matrices (and vectors) More...
 
subroutine, public solver_matrices_routines::solver_matrices_library_type_set (SOLVER_MATRICES, LIBRARY_TYPE, ERR, ERROR,)
 Sets the library type for the solver matrices (and vectors) More...
 
subroutine, public solver_matrices_routines::solver_matrices_output (ID, SELECTION_TYPE, SOLVER_MATRICES, ERR, ERROR,)
 Outputs the solver matrices. More...
 
subroutine solver_matrices_routines::solver_matrices_storage_type_get (SOLVER_MATRICES, STORAGE_TYPE, ERR, ERROR,)
 Gets the storage type (sparsity) of the solver matrices. More...
 
subroutine, public solver_matrices_routines::solver_matrices_storage_type_set (SOLVER_MATRICES, STORAGE_TYPE, ERR, ERROR,)
 Sets the storage type (sparsity) of the solver matrices. More...
 
subroutine, public solver_matrices_routines::solver_matrix_equations_matrix_add (SOLVER_MATRIX, equations_set_idx, ALPHA, EQUATIONS_MATRIX, ERR, ERROR,)
 Adds alpha times the equations matrix into the solver matrix. More...
 
subroutine, public solver_matrices_routines::solver_matrix_interface_matrix_add (SOLVER_MATRIX, interface_condition_idx, ALPHA, INTERFACE_MATRIX, ERR, ERROR,)
 Adds alpha times the interface matrix into the solver matrix. More...
 
subroutine, public solver_matrices_routines::solver_matrix_jacobian_matrix_add (SOLVER_MATRIX, equations_set_idx, ALPHA, JACOBIAN_MATRIX, ERR, ERROR,)
 Adds alpha times the Jacobian matrix into the solver matrix. More...
 
subroutine solver_matrices_routines::solver_matrix_structure_calculate (SOLVER_MATRIX, NUMBER_OF_NON_ZEROS, ROW_INDICES, COLUMN_INDICES, ERR, ERROR,)
 Calculates the structure (sparsity) of the solver matrix from the soluton mapping. More...
 
subroutine solver_matrices_routines::solver_matrix_finalise (SOLVER_MATRIX, ERR, ERROR,)
 Finalises a solver matrix and deallocates all memory. More...
 
subroutine solver_matrices_routines::solver_matrix_form (SOLVER_MATRIX, ERR, ERROR,)
 Forms a solver matrix by initialising the structure of the matrix to zero. More...
 
subroutine solver_matrices_routines::solver_matrix_initialise (SOLVER_MATRICES, MATRIX_NUMBER, ERR, ERROR,)
 Initialises a solver matrix. More...
 

Variables

integer(intg), parameter, public solver_matrices_routines::solver_matrices_all =1
 Select all the solver matrices and vectors. More...
 
integer(intg), parameter, public solver_matrices_routines::solver_matrices_linear_only =3
 Select only the linear solver matrices and vectors. More...
 
integer(intg), parameter, public solver_matrices_routines::solver_matrices_nonlinear_only =4
 Select only the nonlinear solver matrices and vectors. More...
 
integer(intg), parameter, public solver_matrices_routines::solver_matrices_jacobian_only =5
 Select only the Jacobian solver matrix. More...
 
integer(intg), parameter, public solver_matrices_routines::solver_matrices_residual_only =6
 Select only the residual solver vector. More...
 
integer(intg), parameter, public solver_matrices_routines::solver_matrices_rhs_only =7
 Select only the RHS solver vector. More...
 
integer(intg), parameter, public solver_matrices_routines::solver_matrices_rhs_residual_only =8
 Select only the residual and RHS solver vectors. More...
 

Detailed Description

This module handles all solver matrix and rhs 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_matrices_routines.f90.