error_analysis Module Reference

This module is an example for the error_analysis module which shall hold the user defined error analysis functions. More...

Data Types
interface	are_identical
interface	average_relative_error
interface	chi_square
interface	maximum_relative_error

Public Member Functions
character(len=132) function	are_identical_float (diff_counter, error_level, reference_field_float, new_field_float, reference_field_array3dflt_type, new_field_array3dflt_type, reference_field_array4dflt_type, new_field_array4dflt_type, reference_field_array5dflt_type, new_field_array5dflt_type, reference_field_array6dflt_type, new_field_array6dflt_type, reference_field_array7dflt_type, new_field_array7dflt_type, reference_field_matflt_type, new_field_matflt_type, reference_field_vecflt_type, new_field_vecflt_type)
character(len=132) function	are_identical_float_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	are_identical_vecflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	are_identical_matflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	are_identical_array3dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	are_identical_array4dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	are_identical_array5dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	are_identical_array6dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	are_identical_array7dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_float (diff_counter, error_level, reference_field_float, new_field_float, reference_field_array3dflt_type, new_field_array3dflt_type, reference_field_array4dflt_type, new_field_array4dflt_type, reference_field_array5dflt_type, new_field_array5dflt_type, reference_field_array6dflt_type, new_field_array6dflt_type, reference_field_array7dflt_type, new_field_array7dflt_type, reference_field_matflt_type, new_field_matflt_type, reference_field_vecflt_type, new_field_vecflt_type)
character(len=132) function	average_relative_error_float_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_vecflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_matflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_array3dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_array4dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_array5dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_array6dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	average_relative_error_array7dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_float (diff_counter, error_level, reference_field_float, new_field_float, reference_field_array3dflt_type, new_field_array3dflt_type, reference_field_array4dflt_type, new_field_array4dflt_type, reference_field_array5dflt_type, new_field_array5dflt_type, reference_field_array6dflt_type, new_field_array6dflt_type, reference_field_array7dflt_type, new_field_array7dflt_type, reference_field_matflt_type, new_field_matflt_type, reference_field_vecflt_type, new_field_vecflt_type)
character(len=132) function	maximum_relative_error_float_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_vecflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_matflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_array3dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_array4dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_array5dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_array6dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	maximum_relative_error_array7dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_float (diff_counter, error_level, reference_field_float, new_field_float, reference_field_array3dflt_type, new_field_array3dflt_type, reference_field_array4dflt_type, new_field_array4dflt_type, reference_field_array5dflt_type, new_field_array5dflt_type, reference_field_array6dflt_type, new_field_array6dflt_type, reference_field_array7dflt_type, new_field_array7dflt_type, reference_field_matflt_type, new_field_matflt_type, reference_field_vecflt_type, new_field_vecflt_type)
character(len=132) function	chi_square_float_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_vecflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_matflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_array3dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_array4dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_array5dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_array6dflt_type (reference_field, new_field, diff_counter, error_level)
character(len=132) function	chi_square_array7dflt_type (reference_field, new_field, diff_counter, error_level)

Detailed Description

This module is an example for the error_analysis module which shall hold the user defined error analysis functions.

Those functions can be arbitrary functions. They only have to follow the following structure:

func(reference_field, new_field, diff_counter)

where reference_field and new_field must have the same type and be of a real type (scalar or array, 1D - 7D) and diff_counter is an integer.

You must define overloaded versions of each function for all required real types (scalar, array, 1D - 7D) as shown in the example.

Author

Christian Konz

Version

"$Id $"

Definition at line 19 of file error_analysis.f90.

Member Function/Subroutine Documentation

character(len = 132) function error_analysis::are_identical_array3dflt_type	(	real(r8), dimension(:, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 189 of file error_analysis.f90.

character(len = 132) function error_analysis::are_identical_array4dflt_type	(	real(r8), dimension(:, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 213 of file error_analysis.f90.

character(len = 132) function error_analysis::are_identical_array5dflt_type	(	real(r8), dimension(:, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 237 of file error_analysis.f90.

character(len = 132) function error_analysis::are_identical_array6dflt_type	(	real(r8), dimension(:, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 261 of file error_analysis.f90.

character(len = 132) function error_analysis::are_identical_array7dflt_type	(	real(r8), dimension(:, :, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 285 of file error_analysis.f90.

character(len = 132) function error_analysis::are_identical_float	(	integer(itm_i4)	diff_counter,
		real(r8)	error_level,
		real(r8), intent(in), optional	reference_field_float,
		real(r8), intent(in), optional	new_field_float,
		real(r8), dimension(:, :, :), optional, pointer	reference_field_array3dflt_type,
		real(r8), dimension(:, :, :), optional, pointer	new_field_array3dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	reference_field_array4dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	new_field_array4dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	reference_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	new_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	reference_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	new_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	reference_field_array7dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	new_field_array7dflt_type,
		real(r8), dimension(:, :), optional, pointer	reference_field_matflt_type,
		real(r8), dimension(:, :), optional, pointer	new_field_matflt_type,
		real(r8), dimension(:), optional, pointer	reference_field_vecflt_type,
		real(r8), dimension(:), optional, pointer	new_field_vecflt_type
	)

Definition at line 75 of file error_analysis.f90.

Here is the caller graph for this function:

character(len = 132) function error_analysis::are_identical_float_type	(	real(r8), intent(in)	reference_field,
		real(r8), intent(in)	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 121 of file error_analysis.f90.

character(len = 132) function error_analysis::are_identical_matflt_type	(	real(r8), dimension(:, :), pointer	reference_field,
		real(r8), dimension(:, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 165 of file error_analysis.f90.

character(len = 132) function error_analysis::are_identical_vecflt_type	(	real(r8), dimension(:), pointer	reference_field,
		real(r8), dimension(:), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 141 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_array3dflt_type	(	real(r8), dimension(:, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 472 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_array4dflt_type	(	real(r8), dimension(:, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 520 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_array5dflt_type	(	real(r8), dimension(:, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 570 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_array6dflt_type	(	real(r8), dimension(:, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 622 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_array7dflt_type	(	real(r8), dimension(:, :, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 679 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_float	(	integer(itm_i4)	diff_counter,
		real(r8)	error_level,
		real(r8), intent(in), optional	reference_field_float,
		real(r8), intent(in), optional	new_field_float,
		real(r8), dimension(:, :, :), optional, pointer	reference_field_array3dflt_type,
		real(r8), dimension(:, :, :), optional, pointer	new_field_array3dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	reference_field_array4dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	new_field_array4dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	reference_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	new_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	reference_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	new_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	reference_field_array7dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	new_field_array7dflt_type,
		real(r8), dimension(:, :), optional, pointer	reference_field_matflt_type,
		real(r8), dimension(:, :), optional, pointer	new_field_matflt_type,
		real(r8), dimension(:), optional, pointer	reference_field_vecflt_type,
		real(r8), dimension(:), optional, pointer	new_field_vecflt_type
	)

Definition at line 309 of file error_analysis.f90.

Here is the caller graph for this function:

character(len = 132) function error_analysis::average_relative_error_float_type	(	real(r8), intent(in)	reference_field,
		real(r8), intent(in)	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 355 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_matflt_type	(	real(r8), dimension(:, :), pointer	reference_field,
		real(r8), dimension(:, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 426 of file error_analysis.f90.

character(len = 132) function error_analysis::average_relative_error_vecflt_type	(	real(r8), dimension(:), pointer	reference_field,
		real(r8), dimension(:), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 383 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_array3dflt_type	(	real(r8), dimension(:, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1329 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_array4dflt_type	(	real(r8), dimension(:, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1372 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_array5dflt_type	(	real(r8), dimension(:, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1417 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_array6dflt_type	(	real(r8), dimension(:, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1464 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_array7dflt_type	(	real(r8), dimension(:, :, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1513 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_float	(	integer(itm_i4)	diff_counter,
		real(r8)	error_level,
		real(r8), intent(in), optional	reference_field_float,
		real(r8), intent(in), optional	new_field_float,
		real(r8), dimension(:, :, :), optional, pointer	reference_field_array3dflt_type,
		real(r8), dimension(:, :, :), optional, pointer	new_field_array3dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	reference_field_array4dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	new_field_array4dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	reference_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	new_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	reference_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	new_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	reference_field_array7dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	new_field_array7dflt_type,
		real(r8), dimension(:, :), optional, pointer	reference_field_matflt_type,
		real(r8), dimension(:, :), optional, pointer	new_field_matflt_type,
		real(r8), dimension(:), optional, pointer	reference_field_vecflt_type,
		real(r8), dimension(:), optional, pointer	new_field_vecflt_type
	)

Definition at line 1177 of file error_analysis.f90.

Here is the caller graph for this function:

character(len = 132) function error_analysis::chi_square_float_type	(	real(r8), intent(in)	reference_field,
		real(r8), intent(in)	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1223 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_matflt_type	(	real(r8), dimension(:, :), pointer	reference_field,
		real(r8), dimension(:, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1288 of file error_analysis.f90.

character(len = 132) function error_analysis::chi_square_vecflt_type	(	real(r8), dimension(:), pointer	reference_field,
		real(r8), dimension(:), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1249 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_array3dflt_type	(	real(r8), dimension(:, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 907 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_array4dflt_type	(	real(r8), dimension(:, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 957 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_array5dflt_type	(	real(r8), dimension(:, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1009 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_array6dflt_type	(	real(r8), dimension(:, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1063 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_array7dflt_type	(	real(r8), dimension(:, :, :, :, :, :, :), pointer	reference_field,
		real(r8), dimension(:, :, :, :, :, :, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 1119 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_float	(	integer(itm_i4)	diff_counter,
		real(r8)	error_level,
		real(r8), intent(in), optional	reference_field_float,
		real(r8), intent(in), optional	new_field_float,
		real(r8), dimension(:, :, :), optional, pointer	reference_field_array3dflt_type,
		real(r8), dimension(:, :, :), optional, pointer	new_field_array3dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	reference_field_array4dflt_type,
		real(r8), dimension(:, :, :, :), optional, pointer	new_field_array4dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	reference_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :), optional, pointer	new_field_array5dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	reference_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :), optional, pointer	new_field_array6dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	reference_field_array7dflt_type,
		real(r8), dimension(:, :, :, :, :, :, :), optional, pointer	new_field_array7dflt_type,
		real(r8), dimension(:, :), optional, pointer	reference_field_matflt_type,
		real(r8), dimension(:, :), optional, pointer	new_field_matflt_type,
		real(r8), dimension(:), optional, pointer	reference_field_vecflt_type,
		real(r8), dimension(:), optional, pointer	new_field_vecflt_type
	)

Definition at line 738 of file error_analysis.f90.

Here is the caller graph for this function:

character(len = 132) function error_analysis::maximum_relative_error_float_type	(	real(r8), intent(in)	reference_field,
		real(r8), intent(in)	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 784 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_matflt_type	(	real(r8), dimension(:, :), pointer	reference_field,
		real(r8), dimension(:, :), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 859 of file error_analysis.f90.

character(len = 132) function error_analysis::maximum_relative_error_vecflt_type	(	real(r8), dimension(:), pointer	reference_field,
		real(r8), dimension(:), pointer	new_field,
		integer(itm_i4)	diff_counter,
		real(r8)	error_level
	)

Definition at line 813 of file error_analysis.f90.

---

The documentation for this module was generated from the following file:

• src/itm_tools/error_analysis.f90