Compute the error of a field defined on cells or faces.

Public Member Functions
subroutine	compute_error_cell (field, reference_field, grid_volume, is_relative_error, mask, error_l1, error_l2, error_linf)
	Compute relative or absolute error of a field defined on cells with respect to a reference field.

subroutine	compute_error_face (field, reference_field, grid_volume, is_relative_error, mask, error_l1, error_l1_u, error_l1_v, error_l1_w, error_l2, error_l2_u, error_l2_v, error_l2_w, error_linf, error_linf_u, error_linf_v, error_linf_w)
	Compute error of a field defined on faces with respect to a reference field.

Member Function/Subroutine Documentation

◆ compute_error_cell()

subroutine mod_compute_error::compute_error::compute_error_cell	(	double precision, dimension(:,:,:), intent(in)	field,
		double precision, dimension(:,:,:), intent(in)	reference_field,
		double precision, dimension(:,:,:), intent(in)	grid_volume,
		logical, intent(in)	is_relative_error,
		logical, dimension(:,:,:), intent(in), optional	mask,
		double precision, intent(out), optional	error_l1,
		double precision, intent(out), optional	error_l2,
		double precision, intent(out), optional	error_linf )

The error is computed against the argument reference_field, which must be a cell-centered field.

Parameters

[in]	field	cell-centered field
[in]	reference_field	cell-centered field
[in]	grid_volume	volume of the grid where `field` is defined
[in]	is_relative_error	boolean to compute relative or absolute error
[in]	mask	restrict the sum where `mask` is .true.
[out]	error_l1	L1 norm of the error
[out]	error_l2	L2 norm of the error
[out]	error_linf	Linf norm of the error

subroutine mod_compute_error::compute_error::compute_error_face	(	type(t_face_field), intent(in)	field,
		type(t_face_field), intent(in)	reference_field,
		type(t_face_field), intent(in)	grid_volume,
		logical, intent(in)	is_relative_error,
		type(t_logical_face_field), intent(in), optional	mask,
		double precision, intent(out), optional	error_l1,
		double precision, intent(out), optional	error_l1_u,
		double precision, intent(out), optional	error_l1_v,
		double precision, intent(out), optional	error_l1_w,
		double precision, intent(out), optional	error_l2,
		double precision, intent(out), optional	error_l2_u,
		double precision, intent(out), optional	error_l2_v,
		double precision, intent(out), optional	error_l2_w,
		double precision, intent(out), optional	error_linf,
		double precision, intent(out), optional	error_linf_u,
		double precision, intent(out), optional	error_linf_v,
		double precision, intent(out), optional	error_linf_w )

The error is computed against the argument reference_field, which must be a face-centered field.

Parameters

[in]	field	face-centered field
[in]	reference_field	face-centered field
[in]	grid_volume	volume of the grid where `field` is defined
[in]	is_relative_error	boolean to compute relative or absolute error
[in]	mask	restrict the sum where `mask` is .true.
[out]	error_l1	L1 norm of the error on all vector components
[out]	error_l1_u	L1 norm of the error in direction _u
[out]	error_l1_v	L1 norm of the error in direction _v
[out]	error_l1_w	L1 norm of the error in direction _w
[out]	error_l2	L2 norm of the error on all vector components
[out]	error_l2_u	L2 norm of the error in direction _u
[out]	error_l2_v	L2 norm of the error in direction _v
[out]	error_l2_w	L2 norm of the error in direction _w
[out]	error_linf	Linf norm of the error on all vector components
[out]	error_linf_u	Linf norm of the error in direction _u
[out]	error_linf_v	Linf norm of the error in direction _v
[out]	error_linf_w	Linf norm of the error in direction _w

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