analytic_analysis_routines.f90 File Reference

This module handles all analytic analysis routines. More...

Go to the source code of this file.

Modules
module	analytic_analysis_routines
	This module handles all analytic analysis routines.

Functions/Subroutines
subroutine, public	analytic_analysis_routines::analyticanalysis_output (FIELD, FILENAME, ERR, ERROR,)
	Output the analytic error analysis for a dependent field compared to the analytic values parameter set. More...
pure real(dp) function	analytic_analysis_routines::analytic_analysis_absolute_error (NUMERIC_VALUE, ANALYTIC_VALUE)
	Calculates the absolute error between a numeric value and an analytic value. More...
pure real(dp) function	analytic_analysis_routines::analytic_analysis_percentage_error (NUMERIC_VALUE, ANALYTIC_VALUE)
	Calculates the percentage error between a numeric value and an analytic value. More...
pure real(dp) function	analytic_analysis_routines::analytic_analysis_relative_error (NUMERIC_VALUE, ANALYTIC_VALUE)
	Calculates the relative error between a numeric value and an analytic value. More...
pure real(dp) function	analytic_analysis_routines::analytic_analysis_nid_error (NUMERIC_VALUE, ANALYTIC_VALUE)
	Calculates the Normalised Integral Difference (NID) error with a numeric value and an analytic value. More...
subroutine	analytic_analysis_routines::analytic_analysis_integral_errors (FIELD_VARIABLE, INTEGRAL_ERRORS, GHOST_INTEGRAL_ERRORS, ERR, ERROR,)
	Calculates the relative error between a numeric value and an analytic value. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_integralabsoluteerrorget (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, INTEGRAL_ERROR, GHOST_INTEGRAL_ERROR, ERR, ERROR,)
	Get integral absolute error value for the field. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_integralanalyticvalueget (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, INTEGRAL_ERROR, GHOST_INTEGRAL_ERROR, ERR, ERROR,)
	Get integral analytic value for the field TODO should we use analytical formula to calculate the integration? More...
subroutine, public	analytic_analysis_routines::analyticanalysis_integralnumericalvalueget (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, INTEGRAL_ERROR, GHOST_INTEGRAL_ERROR, ERR, ERROR,)
	Get integral numerical value for the field, TODO check integral calculation. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_integralnidnumericalvalueget (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, INTEGRAL_ERROR, GHOST_INTEGRAL_ERROR, ERR, ERROR,)
	Get integral nid numerical value for the field, TODO check integral calculation. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_integralniderrorget (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, INTEGRAL_ERROR, GHOST_INTEGRAL_ERROR, ERR, ERROR,)
	Get integral nid error value for the field. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_integralpercentageerrorget (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, INTEGRAL_ERROR, GHOST_INTEGRAL_ERROR, ERR, ERROR,)
	Get integral percentage error value for the field. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_integralrelativeerrorget (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, INTEGRAL_ERROR, GHOST_INTEGRAL_ERROR, ERR, ERROR,)
	Get integral relative error value for the field. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_absoluteerrorgetnode (FIELD, VARIABLE_TYPE, VERSION_NUMBER, DERIVATIVE_NUMBER, USER_NODE_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get absolute error value for the node. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_percentageerrorgetnode (FIELD, VARIABLE_TYPE, VERSION_NUMBER, DERIVATIVE_NUMBER, USER_NODE_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get percentage error value for the node. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_relativeerrorgetnode (FIELD, VARIABLE_TYPE, VERSION_NUMBER, DERIVATIVE_NUMBER, USER_NODE_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get relative error value for the node. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_absoluteerrorgetelement (FIELD, VARIABLE_TYPE, USER_ELEMENT_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get absolute error value for an element. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_percentageerrorgetelement (FIELD, VARIABLE_TYPE, USER_ELEMENT_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get percentage error value for the node. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_relativeerrorgetelement (FIELD, VARIABLE_TYPE, USER_ELEMENT_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get relative error value for an element. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_absoluteerrorgetconstant (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get absolute error value for the node. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_percentageerrorgetconstant (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get percentage error value for a constant. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_relativeerrorgetconstant (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
	Get relative error value for a constant. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_rmserrorgetnode (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, ERROR_TYPE, LOCAL_RMS, LOCAL_GHOST_RMS, GLOBAL_RMS, ERR, ERROR,)
	Get rms error value for the field. More...
subroutine, public	analytic_analysis_routines::analyticanalysis_rmserrorgetelement (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, ERROR_TYPE, LOCAL_RMS, LOCAL_GHOST_RMS, GLOBAL_RMS, ERR, ERROR,)
	Get rms error value for the field. More...

Variables
integer(intg), parameter	analytic_analysis_routines::absolute_error_type =1
	The absolute type. More...
integer(intg), parameter	analytic_analysis_routines::percentage_error_type =2
	The percentage type. More...
integer(intg), parameter	analytic_analysis_routines::relative_error_type =3
	The relative type. More...

Detailed Description

This module handles all analytic analysis routines.

Author

Ting Yu

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