OpenCMISS-Iron Internal API Documentation
fieldml_output_routines.f90 File Reference

This module handles writing out FieldML files. More...

Go to the source code of this file.

Data Types

type  fieldml_output_routines::connectivity_info_type
 
type  fieldml_output_routines::basis_info_type
 
interface  fieldml_output_routines::fieldml_output_add_field
 

Modules

module  fieldml_output_routines
 Output routines for FieldML.
 

Functions/Subroutines

subroutine fieldml_output_routines::fieldml_assert_is_out (FIELDML_INFO, ERR, ERROR,)
 Asserts that the FieldML Info is associated and created for output. More...
 
subroutine fieldml_output_routines::fieldml_output_get_collapse_suffix (COLLAPSE_INFO, SUFFIX, ERR, ERROR,)
 Get the text suffix corresponding to the given array of collapse constants. More...
 
integer(intg) function fieldml_output_routines::fieldml_output_import_fml (FML_HANDLE, REMOTE_NAME, ERR, ERROR)
 Import the named object from the built-in library into the current FieldML document. The local name will be the same as the remote name. More...
 
integer(intg) function fieldml_output_routines::fieldml_output_import (FIELDML_INFO, REMOTE_NAME, ERR, ERROR)
 Import the named object from the built-in library into the current FieldML document. The local name will be the same as the remote name. More...
 
integer(intg) function, public fieldml_output_routines::fieldml_output_add_import (FIELDML_INFO, REMOTE_NAME, ERR, ERROR)
 Import the named object from the built-in library into the current FieldML document. The local name will be the same as the remote name. More...
 
integer(intg) function fieldml_output_routines::fieldml_output_import_handle (FML_HANDLE, HANDLE, ERR, ERROR)
 Import the given FieldML object if it is not already imported or local. More...
 
integer(intg) function fieldml_output_routines::fieldml_output_get_type_argument_handle (FIELDML_INFO, TYPE_HANDLE, DO_IMPORT, ERR, ERROR)
 Get the argument corresponding to the given type (named *.argument), importing it if needed. More...
 
subroutine fieldml_output_routines::fieldml_output_get_coordinates_type (FIELDML_HANDLE, COORDS_TYPE, DIMENSIONS, DO_IMPORT, TYPE_HANDLE, ERR, ERROR,)
 Get the FieldML built-in library type corresponding to the given OpenCMISS coordinate system type. More...
 
subroutine fieldml_output_routines::fieldml_output_get_generic_type (FIELDML_HANDLE, DIMENSIONS, TYPE_HANDLE, DO_IMPORT, ERR, ERROR,)
 Returns a generic n-dimensional real type from the built-in library. More...
 
subroutine fieldml_output_routines::fieldml_output_get_xi_type (FIELDML_HANDLE, DIMENSIONS, DO_IMPORT, TYPE_HANDLE, ERR, ERROR,)
 Returns a type in the built-in library corresponding to a chart of the given dimensionality. More...
 
subroutine fieldml_output_routines::fieldml_output_get_value_type (FML_HANDLE, FIELD, VARIABLE_TYPE, DO_IMPORT, TYPE_HANDLE, ERR, ERROR,)
 Returns a FieldML type appropriate for the given OpenCMISS field. More...
 
subroutine fieldml_output_routines::fieldml_output_get_tp_basis_evaluator (FML_HANDLE, XI_INTERPOLATIONS, COLLAPSE_INFO, EVALUATOR_HANDLE, PARAMETERS_HANDLE, ERR, ERROR,)
 Get an evaluator from the built-in library that corresponds to the given OpenCMISS tensor-product basis. More...
 
subroutine fieldml_output_routines::fieldmloutputgetsimplexbasisevaluator (fmlHandle, xiInterpolations, evaluatorHandle, parametersHandle, err, error,)
 Get an evaluator from the built-in library that corresponds to the given OpenCMISS simplex basis. Currently does not support collapsed bases. More...
 
subroutine fieldml_output_routines::fieldml_output_get_tp_connectivity_type (FIELDML_HANDLE, XI_INTERPOLATIONS, COLLAPSE_INFO, DO_IMPORT, TYPE_HANDLE, ERR, ERROR,)
 Return the FieldML connectivity ensemble corresponding to the given tensor-product basis info. More...
 
subroutine fieldml_output_routines::fieldmloutputgetsimplexconnectivitytype (fieldmlHandle, xiInterpolations, doImport, typeHandle, err, error,)
 Return the FieldML connectivity ensemble corresponding to the given simplex basis info. More...
 
subroutine fieldml_output_routines::fieldml_output_get_connectivity_ensemble (FIELDML_HANDLE, BASIS, TYPE_HANDLE, ERR, ERROR,)
 Get the connectivity ensemble for the given basis. Currently, only tensor-product bases are supported. More...
 
integer(intg) function fieldml_output_routines::fieldml_output_find_layout (CONNECTIVITY_INFO, LAYOUT_HANDLE, ERR, ERROR)
 Returns the index of the layout handle used by the given connectivity info array, or -1 if none can be found. More...
 
integer(intg) function fieldml_output_routines::fieldml_output_find_basis (BASIS_INFO, BASIS, ERR, ERROR)
 Returns the index of the basis handle used by the given basis info array, or -1 if none can be found. More...
 
subroutine fieldml_output_routines::fieldml_output_get_simple_layout_name (FML_HANDLE, LAYOUT_HANDLE, NAME, ERR, ERROR,)
 Returns the simplified name of the given layout. This is used for naming associated connectivity evaluators. More...
 
subroutine fieldml_output_routines::fieldml_output_get_simple_basis_name (FML_HANDLE, BASIS_HANDLE, NAME, ERR, ERROR,)
 Returns the simplified name of the given basis. This is used for naming associated reference evaluators. More...
 
subroutine fieldml_output_routines::fieldml_output_create_basis_reference (FIELDML_INFO, BASE_NAME, BASIS_INFO, ERR, ERROR,)
 Create a basis evaluator from the given basis info. More...
 
subroutine fieldml_output_routines::fieldml_output_create_layout_parameters (FIELDML_INFO, LAYOUT_HANDLE, COMPONENT_NAME, CONNECTIVITY_INFO, ERR, ERROR,)
 Create a parameter evaluator for the given local node layout. More...
 
subroutine fieldml_output_routines::fieldml_output_add_mesh_component (FIELDML_INFO, BASE_NAME, CONNECTIVITY_FORMAT, COMPONENT_NUMBER, MESH_ELEMENTS, ERR, ERROR,)
 Add an evaluator corresponding to the given component of the given OpenCMISS mesh. More...
 
subroutine fieldml_output_routines::fieldml_output_add_field_node_dofs (FIELDML_INFO, BASE_NAME, DOF_FORMAT, TYPE_HANDLE, FIELD, FIELD_COMPONENT_NUMBERS, VARIABLE_TYPE, SET_TYPE, NODE_DOFS_HANDLE, ERR, ERROR,)
 Create a parameter evaluator and associated data source containing the nodal dofs for the given field components. More...
 
subroutine fieldml_output_routines::fieldml_output_add_field_element_dofs (FIELDML_INFO, BASE_NAME, DOF_FORMAT, TYPE_HANDLE, FIELD, FIELD_COMPONENT_NUMBERS, VARIABLE_TYPE, SET_TYPE, ELEMENT_DOFS_HANDLE, ERR, ERROR,)
 Create a parameter evaluator and associated data source containing the element dofs for the given field components. More...
 
subroutine fieldml_output_routines::fieldml_output_add_field_constant_dofs (FIELDML_INFO, BASE_NAME, DOF_FORMAT, TYPE_HANDLE, FIELD, FIELD_COMPONENT_NUMBERS, VARIABLE_TYPE, SET_TYPE, CONSTANT_DOFS_HANDLE, ERR, ERROR,)
 Create a parameter evaluator and associated data source containing the globally constant dofs for the given field components. More...
 
subroutine, public fieldml_output_routines::fieldml_output_initialise_info (MESH, LOCATION, BASE_NAME, CONNECTIVITY_FORMAT, FIELDML_INFO, ERR, ERROR,)
 Initialize the given FieldML parsing state for use with the given mesh. More...
 
subroutine, public fieldml_output_routines::fieldml_output_add_field_components (FIELDML_INFO, TYPE_HANDLE, BASE_NAME, DOF_FORMAT, FIELD, FIELD_COMPONENT_NUMBERS, VARIABLE_TYPE, SET_TYPE, ERR, ERROR,)
 Add the components of the given field to the given FieldML evaluator, creating component templates as needed. More...
 
subroutine fieldml_output_routines::fieldml_output_add_field_no_type (FIELDML_INFO, BASE_NAME, DOF_FORMAT, FIELD, VARIABLE_TYPE, SET_TYPE, ERR, ERROR,)
 Add the given field to the given FieldML document. The field's type will be determined by FieldmlUtilGetValueType. More...
 
subroutine fieldml_output_routines::fieldml_output_add_field_with_type (FIELDML_INFO, BASE_NAME, DOF_FORMAT, FIELD, VARIABLE_TYPE, SET_TYPE, TYPE_HANDLE, ERR, ERROR,)
 Add the given field to the given FieldML document using the given FieldML type. More...
 
subroutine, public fieldml_output_routines::fieldml_output_write (FIELDML_INFO, FILENAME, ERR, ERROR,)
 Write the given FieldML document to the given file. More...
 

Detailed Description

This module handles writing out FieldML files.

Author
Caton Little

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 fieldml_output_routines.f90.