OpenCMISS-Iron Internal API Documentation
analytic_analysis_routines Module Reference

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

Functions/Subroutines

subroutine, public 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_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_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_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_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_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 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 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 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 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 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 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 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 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 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 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 analyticanalysis_absoluteerrorgetelement (FIELD, VARIABLE_TYPE, USER_ELEMENT_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
 Get absolute error value for an element. More...
 
subroutine, public analyticanalysis_percentageerrorgetelement (FIELD, VARIABLE_TYPE, USER_ELEMENT_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
 Get percentage error value for the node. More...
 
subroutine, public analyticanalysis_relativeerrorgetelement (FIELD, VARIABLE_TYPE, USER_ELEMENT_NUMBER, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
 Get relative error value for an element. More...
 
subroutine, public analyticanalysis_absoluteerrorgetconstant (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
 Get absolute error value for the node. More...
 
subroutine, public analyticanalysis_percentageerrorgetconstant (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
 Get percentage error value for a constant. More...
 
subroutine, public analyticanalysis_relativeerrorgetconstant (FIELD, VARIABLE_TYPE, COMPONENT_NUMBER, VALUE, ERR, ERROR,)
 Get relative error value for a constant. More...
 
subroutine, public 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 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 absolute_error_type =1
 The absolute type. More...
 
integer(intg), parameter percentage_error_type =2
 The percentage type. More...
 
integer(intg), parameter relative_error_type =3
 The relative type. More...
 

Detailed Description

This module handles all analytic analysis routines.

Function/Subroutine Documentation

pure real(dp) function analytic_analysis_routines::analytic_analysis_absolute_error ( real(dp), intent(in)  NUMERIC_VALUE,
real(dp), intent(in)  ANALYTIC_VALUE 
)
private

Calculates the absolute error between a numeric value and an analytic value.

Parameters
[in]numeric_valueThe numerical value for the error calculation
[in]analytic_valueThe analytic value for the error calculation

Definition at line 710 of file analytic_analysis_routines.f90.

Referenced by analyticanalysis_absoluteerrorgetconstant(), analyticanalysis_absoluteerrorgetelement(), analyticanalysis_absoluteerrorgetnode(), analyticanalysis_integralabsoluteerrorget(), and analyticanalysis_output().

subroutine analytic_analysis_routines::analytic_analysis_integral_errors ( type(field_variable_type), pointer  FIELD_VARIABLE,
real(dp), dimension(:,:), intent(out)  INTEGRAL_ERRORS,
real(dp), dimension(:,:), intent(out)  GHOST_INTEGRAL_ERRORS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Calculates the relative error between a numeric value and an analytic value.

Parameters
field_variableA pointer to the field variable to calculate the integral errors for
[out]integral_errorsOn exit, the integral errors for the local elements
[out]ghost_integral_errorsOn exit, the integral errors for the ghost elements
[out]errThe error code
[out]errorThe error string

Definition at line 790 of file analytic_analysis_routines.f90.

References basis_routines::basis_default_quadrature_scheme, constants::first_part_deriv, and constants::no_part_deriv.

Referenced by analyticanalysis_integralabsoluteerrorget(), analyticanalysis_integralanalyticvalueget(), analyticanalysis_integralniderrorget(), analyticanalysis_integralnidnumericalvalueget(), analyticanalysis_integralnumericalvalueget(), analyticanalysis_integralpercentageerrorget(), analyticanalysis_integralrelativeerrorget(), and analyticanalysis_output().

pure real(dp) function analytic_analysis_routines::analytic_analysis_nid_error ( real(dp), intent(in)  NUMERIC_VALUE,
real(dp), intent(in)  ANALYTIC_VALUE 
)
private

Calculates the Normalised Integral Difference (NID) error with a numeric value and an analytic value.

Parameters
[in]numeric_valueThe numerical value for the error calculation
[in]analytic_valueThe analytic value for the error calculation

Definition at line 769 of file analytic_analysis_routines.f90.

References constants::zero_tolerance.

Referenced by analyticanalysis_integralniderrorget(), and analyticanalysis_output().

pure real(dp) function analytic_analysis_routines::analytic_analysis_percentage_error ( real(dp), intent(in)  NUMERIC_VALUE,
real(dp), intent(in)  ANALYTIC_VALUE 
)
private

Calculates the percentage error between a numeric value and an analytic value.

Parameters
[in]numeric_valueThe numerical value for the error calculation
[in]analytic_valueThe analytic value for the error calculation

Definition at line 727 of file analytic_analysis_routines.f90.

References constants::zero_tolerance.

Referenced by analyticanalysis_integralpercentageerrorget(), analyticanalysis_output(), analyticanalysis_percentageerrorgetconstant(), analyticanalysis_percentageerrorgetelement(), and analyticanalysis_percentageerrorgetnode().

pure real(dp) function analytic_analysis_routines::analytic_analysis_relative_error ( real(dp), intent(in)  NUMERIC_VALUE,
real(dp), intent(in)  ANALYTIC_VALUE 
)
private

Calculates the relative error between a numeric value and an analytic value.

Parameters
[in]numeric_valueThe numerical value for the error calculation
[in]analytic_valueThe analytic value for the error calculation

Definition at line 748 of file analytic_analysis_routines.f90.

References constants::zero_tolerance.

Referenced by analyticanalysis_integralrelativeerrorget(), analyticanalysis_output(), analyticanalysis_relativeerrorgetconstant(), analyticanalysis_relativeerrorgetelement(), and analyticanalysis_relativeerrorgetnode().

subroutine, public analytic_analysis_routines::analyticanalysis_absoluteerrorgetconstant ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get absolute error value for the node.

Parameters
fieldthe field.
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the absolute error
[out]errThe error code
[out]errorThe error string

Definition at line 1526 of file analytic_analysis_routines.f90.

References analytic_analysis_absolute_error().

subroutine, public analytic_analysis_routines::analyticanalysis_absoluteerrorgetelement ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  USER_ELEMENT_NUMBER,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get absolute error value for an element.

Parameters
fieldthe field.
[in]user_element_numbernode number
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the absolute error
[out]errThe error code
[out]errorThe error string

Definition at line 1412 of file analytic_analysis_routines.f90.

References analytic_analysis_absolute_error().

Referenced by analyticanalysis_rmserrorgetelement().

subroutine, public analytic_analysis_routines::analyticanalysis_absoluteerrorgetnode ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  VERSION_NUMBER,
integer(intg), intent(in)  DERIVATIVE_NUMBER,
integer(intg), intent(in)  USER_NODE_NUMBER,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get absolute error value for the node.

Parameters
fieldthe field.
[in]version_numberderivative version number
[in]derivative_numberderivative number
[in]user_node_numbernode number
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the absolute error
[out]errThe error code
[out]errorThe error string

Definition at line 1293 of file analytic_analysis_routines.f90.

References analytic_analysis_absolute_error().

Referenced by analyticanalysis_rmserrorgetnode().

subroutine, public analytic_analysis_routines::analyticanalysis_integralabsoluteerrorget ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), dimension(2), intent(out)  INTEGRAL_ERROR,
real(dp), dimension(2), intent(out)  GHOST_INTEGRAL_ERROR,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get integral absolute error value for the field.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent number
[out]integral_errorOn return, the integral numerical value for local elements
[out]ghost_integral_errorOn return, the integral numerical for global elements
[out]errThe error code
[out]errorThe error string

Definition at line 998 of file analytic_analysis_routines.f90.

References analytic_analysis_absolute_error(), and analytic_analysis_integral_errors().

subroutine, public analytic_analysis_routines::analyticanalysis_integralanalyticvalueget ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), dimension(2), intent(out)  INTEGRAL_ERROR,
real(dp), dimension(2), intent(out)  GHOST_INTEGRAL_ERROR,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get integral analytic value for the field TODO should we use analytical formula to calculate the integration?

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent number
[out]integral_errorOn return, the integral numerical value for local elements
[out]ghost_integral_errorOn return, the integral numerical for global elements
[out]errThe error code
[out]errorThe error string

Definition at line 1041 of file analytic_analysis_routines.f90.

References analytic_analysis_integral_errors().

subroutine, public analytic_analysis_routines::analyticanalysis_integralniderrorget ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), dimension(2), intent(out)  INTEGRAL_ERROR,
real(dp), dimension(2), intent(out)  GHOST_INTEGRAL_ERROR,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get integral nid error value for the field.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent number
[out]integral_errorOn return, the integral numerical value for local elements
[out]ghost_integral_errorOn return, the integral numerical for global elements
[out]errThe error code
[out]errorThe error string

Definition at line 1165 of file analytic_analysis_routines.f90.

References analytic_analysis_integral_errors(), and analytic_analysis_nid_error().

subroutine, public analytic_analysis_routines::analyticanalysis_integralnidnumericalvalueget ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), dimension(2), intent(out)  INTEGRAL_ERROR,
real(dp), dimension(2), intent(out)  GHOST_INTEGRAL_ERROR,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get integral nid numerical value for the field, TODO check integral calculation.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent number
[out]integral_errorOn return, the integral numerical value for local elements
[out]ghost_integral_errorOn return, the integral numerical for global elements
[out]errThe error code
[out]errorThe error string

Definition at line 1123 of file analytic_analysis_routines.f90.

References analytic_analysis_integral_errors().

subroutine, public analytic_analysis_routines::analyticanalysis_integralnumericalvalueget ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), dimension(2), intent(out)  INTEGRAL_ERROR,
real(dp), dimension(2), intent(out)  GHOST_INTEGRAL_ERROR,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get integral numerical value for the field, TODO check integral calculation.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent number
[out]integral_errorOn return, the integral numerical value for local elements
[out]ghost_integral_errorOn return, the integral numerical for global elements
[out]errThe error code
[out]errorThe error string

Definition at line 1082 of file analytic_analysis_routines.f90.

References analytic_analysis_integral_errors().

subroutine, public analytic_analysis_routines::analyticanalysis_integralpercentageerrorget ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), dimension(2), intent(out)  INTEGRAL_ERROR,
real(dp), dimension(2), intent(out)  GHOST_INTEGRAL_ERROR,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get integral percentage error value for the field.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent number
[out]integral_errorOn return, the integral numerical value for local elements
[out]ghost_integral_errorOn return, the integral numerical for global elements
[out]errThe error code
[out]errorThe error string

Definition at line 1207 of file analytic_analysis_routines.f90.

References analytic_analysis_integral_errors(), and analytic_analysis_percentage_error().

subroutine, public analytic_analysis_routines::analyticanalysis_integralrelativeerrorget ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), dimension(2), intent(out)  INTEGRAL_ERROR,
real(dp), dimension(2), intent(out)  GHOST_INTEGRAL_ERROR,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get integral relative error value for the field.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent number
[out]integral_errorOn return, the integral numerical value for local elements
[out]ghost_integral_errorOn return, the integral numerical for global elements
[out]errThe error code
[out]errorThe error string

Definition at line 1250 of file analytic_analysis_routines.f90.

References analytic_analysis_integral_errors(), and analytic_analysis_relative_error().

subroutine, public analytic_analysis_routines::analyticanalysis_output ( type(field_type), intent(in), pointer  FIELD,
character(len=*)  FILENAME,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Output the analytic error analysis for a dependent field compared to the analytic values parameter set.

See also
OPENCMISS::CMISSAnalyticAnalytisOutput
Parameters
[in]fieldA pointer to the dependent field to calculate the analytic error analysis for
filenameIf not empty, the filename to output the analytic analysis to. If empty, the analysis will be output to the standard output
[out]errThe error code
[out]errorThe error string

Definition at line 114 of file analytic_analysis_routines.f90.

References analytic_analysis_absolute_error(), analytic_analysis_integral_errors(), analytic_analysis_nid_error(), analytic_analysis_percentage_error(), analytic_analysis_relative_error(), comp_environment::computational_environment, and cmiss_mpi::mpi_error_check().

Referenced by burgers_equation_routines::burgers_equation_post_solve_output_data(), diffusion_equation_routines::diffusion_equation_post_solve_output_data(), navier_stokes_equations_routines::NAVIER_STOKES_POST_SOLVE_OUTPUT_DATA::navier_stokes_post_solve_output_data(), and stokes_equations_routines::stokes_post_solve_output_data().

subroutine, public analytic_analysis_routines::analyticanalysis_percentageerrorgetconstant ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get percentage error value for a constant.

Parameters
fieldthe field.
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the percentage error
[out]errThe error code
[out]errorThe error string

Definition at line 1562 of file analytic_analysis_routines.f90.

References analytic_analysis_percentage_error().

subroutine, public analytic_analysis_routines::analyticanalysis_percentageerrorgetelement ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  USER_ELEMENT_NUMBER,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get percentage error value for the node.

Parameters
fieldthe field.
[in]user_element_numbernode number
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the percentage error
[out]errThe error code
[out]errorThe error string

Definition at line 1450 of file analytic_analysis_routines.f90.

References analytic_analysis_percentage_error().

Referenced by analyticanalysis_rmserrorgetelement().

subroutine, public analytic_analysis_routines::analyticanalysis_percentageerrorgetnode ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  VERSION_NUMBER,
integer(intg), intent(in)  DERIVATIVE_NUMBER,
integer(intg), intent(in)  USER_NODE_NUMBER,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get percentage error value for the node.

Parameters
fieldthe field.
[in]version_numberderivative version number
[in]derivative_numberderivative number
[in]user_node_numbernode number
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the percentage error
[out]errThe error code
[out]errorThe error string

Definition at line 1332 of file analytic_analysis_routines.f90.

References analytic_analysis_percentage_error().

Referenced by analyticanalysis_rmserrorgetnode().

subroutine, public analytic_analysis_routines::analyticanalysis_relativeerrorgetconstant ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get relative error value for a constant.

Parameters
fieldthe field.
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the relative error
[out]errThe error code
[out]errorThe error string

Definition at line 1600 of file analytic_analysis_routines.f90.

References analytic_analysis_relative_error().

subroutine, public analytic_analysis_routines::analyticanalysis_relativeerrorgetelement ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  USER_ELEMENT_NUMBER,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get relative error value for an element.

Parameters
fieldthe field.
[in]user_element_numbernode number
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the relative error
[out]errThe error code
[out]errorThe error string

Definition at line 1488 of file analytic_analysis_routines.f90.

References analytic_analysis_relative_error().

Referenced by analyticanalysis_rmserrorgetelement().

subroutine, public analytic_analysis_routines::analyticanalysis_relativeerrorgetnode ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  VERSION_NUMBER,
integer(intg), intent(in)  DERIVATIVE_NUMBER,
integer(intg), intent(in)  USER_NODE_NUMBER,
integer(intg), intent(in)  COMPONENT_NUMBER,
real(dp), intent(out)  VALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get relative error value for the node.

Parameters
fieldthe field.
[in]version_numberderivative version number
[in]derivative_numberderivative number
[in]user_node_numbernode number
[in]component_numbercomponent number
[in]variable_typevariable type
[out]valueOn return, the relative error
[out]errThe error code
[out]errorThe error string

Definition at line 1373 of file analytic_analysis_routines.f90.

References analytic_analysis_relative_error().

Referenced by analyticanalysis_rmserrorgetnode().

subroutine, public analytic_analysis_routines::analyticanalysis_rmserrorgetelement ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
integer(intg), intent(in)  ERROR_TYPE,
real(dp), intent(out)  LOCAL_RMS,
real(dp), intent(out)  LOCAL_GHOST_RMS,
real(dp), intent(out)  GLOBAL_RMS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get rms error value for the field.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent index
[in]error_typeerror type
[out]local_rmsOn return, the local rms percentage error
[out]local_ghost_rmsOn return, the local + ghost rms percentage error
[out]global_rmsOn return, the global rms percentage error
[out]errThe error code
[out]errorThe error string

Definition at line 1767 of file analytic_analysis_routines.f90.

References absolute_error_type, analyticanalysis_absoluteerrorgetelement(), analyticanalysis_percentageerrorgetelement(), analyticanalysis_relativeerrorgetelement(), comp_environment::computational_environment, cmiss_mpi::mpi_error_check(), percentage_error_type, and relative_error_type.

subroutine, public analytic_analysis_routines::analyticanalysis_rmserrorgetnode ( type(field_type), pointer  FIELD,
integer(intg), intent(in)  VARIABLE_TYPE,
integer(intg), intent(in)  COMPONENT_NUMBER,
integer(intg), intent(in)  ERROR_TYPE,
real(dp), dimension(8), intent(out)  LOCAL_RMS,
real(dp), dimension(8), intent(out)  LOCAL_GHOST_RMS,
real(dp), dimension(8), intent(out)  GLOBAL_RMS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Get rms error value for the field.

Parameters
fieldthe field.
[in]variable_typevariable type
[in]component_numbercomponent index
[in]error_typeerror type
[out]local_rmsOn return, the local rms percentage error
[out]local_ghost_rmsOn return, the local + ghost rms percentage error
[out]global_rmsOn return, the global rms percentage error
[out]errThe error code
[out]errorThe error string

Definition at line 1637 of file analytic_analysis_routines.f90.

References absolute_error_type, analyticanalysis_absoluteerrorgetnode(), analyticanalysis_percentageerrorgetnode(), analyticanalysis_relativeerrorgetnode(), comp_environment::computational_environment, cmiss_mpi::mpi_error_check(), percentage_error_type, and relative_error_type.