This module provides interfaces to the non-domain-oriented communication subroutines. More...

Data Types
interface	assignment(=)
	Assignment override interface for mpp_efp_type. More...

type	mpp_efp_type
	The Extended Fixed Point (mpp_efp) type provides a public interface for doing sums and taking differences with this type. More...

interface	mpp_reproducing_sum
	This interface uses a conversion to an integer representation of real numbers to give order-invariant sums that will reproduce across PE count. More...

interface	operator(+)
	Operator override interface for mpp_efp_type. More...

interface	operator(-)
	Operator override interface for mpp_efp_type. More...

Functions/Subroutines
subroutine	carry_overflow (int_sum, prec_error)
	This subroutine handles carrying of the overflow.

subroutine	increment_ints (int_sum, int2, prec_error)
	This subroutine increments a number with another, both using the integer representation in real_to_ints.

subroutine	increment_ints_faster (int_sum, r, max_mag_term)
	This subroutine increments a number with another, both using the integer representation in real_to_ints, but without doing any carrying of overflow. The entire operation is embedded in a single call for greater speed.

real(r8_kind) function	ints_to_real (ints)
	This function reverses the conversion in real_to_ints.

subroutine	mpp_efp_assign (efp1, efp2)
	This subroutine assigns all components of the extended fixed point type variable on the RHS (EFP2) to the components of the variable on the LHS (EFP1).

subroutine, public	mpp_efp_list_sum_across_pes (efps, nval, errors)
	This subroutine does a sum across PEs of a list of EFP variables, returning the sums in place, with all overflows carried.

type(mpp_efp_type) function, public	mpp_efp_minus (efp1, efp2)

type(mpp_efp_type) function, public	mpp_efp_plus (efp1, efp2)

real(r8_kind) function, public	mpp_efp_real_diff (efp1, efp2)

real(r8_kind) function, public	mpp_efp_to_real (efp1)

logical function, public	mpp_query_efp_overflow_error ()

type(mpp_efp_type) function, public	mpp_real_to_efp (val, overflow)

real(r4_kind) function	mpp_reproducing_sum_r4_2d (array, isr, ier, jsr, jer, efp_sum, reproducing, overflow_check, err)

real(r8_kind) function	mpp_reproducing_sum_r8_2d (array, isr, ier, jsr, jer, efp_sum, reproducing, overflow_check, err)
	Calculates a reproducing sum for a 2D, 8-byte real array.

real(r8_kind) function	mpp_reproducing_sum_r8_3d (array, isr, ier, jsr, jer, sums, efp_sum, err)
	Reproducing sum for 3d arrays of 8-bit reals.

subroutine, public	mpp_reset_efp_overflow_error ()

integer(i8_kind) function, dimension(numint)	real_to_ints (r, prec_error, overflow)
	This function converts a real number to an equivalent representation using several long integers.

subroutine	regularize_ints (int_sum)
	This subroutine carries the overflow, and then makes sure that all integers are of the same sign as the overall value.

Variables
logical	debug = .false.
	Making this true enables debugging output.

real(r8_kind), dimension(numint), parameter	i_pr = (/ 1.0_8/r_prec2, 1.0_8/r_prec, 1.0_8, r_prec, r_prec2, r_prec**3 /)

real(r8_kind), parameter	i_prec =1.0_8/(2.0_8**NUMBIT)
	The inverse of prec.

integer, parameter	max_count_prec =2**(63-NUMBIT)-1
	The number of values that can be added together with the current value of prec before there will be roundoff problems.

logical	nan_error = .false.

integer, parameter	numint = 6
	The number of long integers to use to represent a real number.

logical	overflow_error = .false.

real(r8_kind), dimension(numint), parameter	pr = (/ r_prec2, r_prec, 1.0_8, 1.0_8/r_prec, 1.0_8/r_prec2, 1.0_8/r_prec**3 /)

integer(i8_kind), parameter	prec =2_8**NUMBIT
	The precision of each integer.

real(r8_kind), parameter	r_prec =2.0_8**NUMBIT
	A real version of prec.

Detailed Description

This module provides interfaces to the non-domain-oriented communication subroutines.

Mainly includes interfaces and type definitions for reproducing operations with extended fixed point data.

Data Type Documentation

◆ mpp_efp_mod::assignment(=)

interface mpp_efp_mod::assignment(=)

Assignment override interface for mpp_efp_type.

Definition at line 94 of file mpp_efp.F90.

Public Member Functions
subroutine	mpp_efp_assign (efp1, efp2)
	This subroutine assigns all components of the extended fixed point type variable on the RHS (EFP2) to the components of the variable on the LHS (EFP1).

Member Function/Subroutine Documentation

◆ mpp_efp_assign()

subroutine mpp_efp_assign	(	type(mpp_efp_type), intent(out)	efp1,
		type(mpp_efp_type), intent(in)	efp2
	)

This subroutine assigns all components of the extended fixed point type variable on the RHS (EFP2) to the components of the variable on the LHS (EFP1).

Definition at line 617 of file mpp_efp.F90.

◆ mpp_efp_mod::mpp_efp_type

type mpp_efp_mod::mpp_efp_type

The Extended Fixed Point (mpp_efp) type provides a public interface for doing sums and taking differences with this type.

Definition at line 80 of file mpp_efp.F90.

Collaboration diagram for mpp_efp_type:

[legend]

Private Attributes
integer(i8_kind), dimension(numint)	v

Member Data Documentation

◆ v

integer(i8_kind), dimension(numint) v

private

Definition at line 82 of file mpp_efp.F90.

◆ mpp_efp_mod::mpp_reproducing_sum

interface mpp_efp_mod::mpp_reproducing_sum

This interface uses a conversion to an integer representation of real numbers to give order-invariant sums that will reproduce across PE count.

This idea comes from R. Hallberg and A. Adcroft.

Definition at line 71 of file mpp_efp.F90.

Public Member Functions
real(r4_kind) function	mpp_reproducing_sum_r4_2d (array, isr, ier, jsr, jer, efp_sum, reproducing, overflow_check, err)

real(r8_kind) function	mpp_reproducing_sum_r8_2d (array, isr, ier, jsr, jer, efp_sum, reproducing, overflow_check, err)
	Calculates a reproducing sum for a 2D, 8-byte real array.

real(r8_kind) function	mpp_reproducing_sum_r8_3d (array, isr, ier, jsr, jer, sums, efp_sum, err)
	Reproducing sum for 3d arrays of 8-bit reals.

Member Function/Subroutine Documentation

◆ mpp_reproducing_sum_r4_2d()

real(r4_kind) function mpp_reproducing_sum_r4_2d	(	real(r4_kind), dimension(:,:), intent(in)	array,
		integer, intent(in), optional	isr,
		integer, intent(in), optional	ier,
		integer, intent(in), optional	jsr,
		integer, intent(in), optional	jer,
		type(mpp_efp_type), intent(out), optional	efp_sum,
		logical, intent(in), optional	reproducing,
		logical, intent(in), optional	overflow_check,
		integer, intent(out), optional	err
	)

Returns: Result

Definition at line 243 of file mpp_efp.F90.

◆ mpp_reproducing_sum_r8_2d()

real(r8_kind) function mpp_reproducing_sum_r8_2d	(	real(r8_kind), dimension(:,:), intent(in)	array,
		integer, intent(in), optional	isr,
		integer, intent(in), optional	ier,
		integer, intent(in), optional	jsr,
		integer, intent(in), optional	jer,
		type(mpp_efp_type), intent(out), optional	efp_sum,
		logical, intent(in), optional	reproducing,
		logical, intent(in), optional	overflow_check,
		integer, intent(out), optional	err
	)

Calculates a reproducing sum for a 2D, 8-byte real array.

Returns: Result

Definition at line 102 of file mpp_efp.F90.

◆ mpp_reproducing_sum_r8_3d()

real(r8_kind) function mpp_reproducing_sum_r8_3d	(	real(r8_kind), dimension(:,:,:), intent(in)	array,
		integer, intent(in), optional	isr,
		integer, intent(in), optional	ier,
		integer, intent(in), optional	jsr,
		integer, intent(in), optional	jer,
		real(r8_kind), dimension(:), intent(out), optional	sums,
		type(mpp_efp_type), intent(out), optional	efp_sum,
		integer, intent(out), optional	err
	)

Reproducing sum for 3d arrays of 8-bit reals.

This function uses a conversion to an integer representation of real numbers to give order-invariant sums that will reproduce across PE count. This idea comes from R. Hallberg and A. Adcroft.

Returns: Result

Definition at line 269 of file mpp_efp.F90.

◆ mpp_efp_mod::operator(+)

interface mpp_efp_mod::operator(+)

Operator override interface for mpp_efp_type.

Definition at line 88 of file mpp_efp.F90.

Public Member Functions
type(mpp_efp_type) function	mpp_efp_plus (efp1, efp2)

Member Function/Subroutine Documentation

◆ mpp_efp_plus()

type(mpp_efp_type) function mpp_efp_plus	(	type(mpp_efp_type), intent(in)	efp1,
		type(mpp_efp_type), intent(in)	efp2
	)

Definition at line 595 of file mpp_efp.F90.

◆ mpp_efp_mod::operator(-)

interface mpp_efp_mod::operator(-)

Operator override interface for mpp_efp_type.

Definition at line 91 of file mpp_efp.F90.

Public Member Functions
type(mpp_efp_type) function	mpp_efp_minus (efp1, efp2)

Member Function/Subroutine Documentation

◆ mpp_efp_minus()

type(mpp_efp_type) function mpp_efp_minus	(	type(mpp_efp_type), intent(in)	efp1,
		type(mpp_efp_type), intent(in)	efp2
	)

Definition at line 604 of file mpp_efp.F90.

Function/Subroutine Documentation

◆ carry_overflow()

subroutine carry_overflow	(	integer(i8_kind), dimension(numint), intent(inout)	int_sum,
		integer(i8_kind), intent(in)	prec_error
	)

private

This subroutine handles carrying of the overflow.

Definition at line 532 of file mpp_efp.F90.

◆ increment_ints()

subroutine increment_ints	(	integer(i8_kind), dimension(numint), intent(inout)	int_sum,
		integer(i8_kind), dimension(numint), intent(in)	int2,
		integer(i8_kind), intent(in), optional	prec_error
	)

private

This subroutine increments a number with another, both using the integer representation in real_to_ints.

Definition at line 479 of file mpp_efp.F90.

◆ increment_ints_faster()

subroutine increment_ints_faster	(	integer(i8_kind), dimension(numint), intent(inout)	int_sum,
		real(r8_kind), intent(in)	r,
		real(r8_kind), intent(inout)	max_mag_term
	)

private

This subroutine increments a number with another, both using the integer representation in real_to_ints, but without doing any carrying of overflow. The entire operation is embedded in a single call for greater speed.

Definition at line 509 of file mpp_efp.F90.

◆ ints_to_real()

real(r8_kind) function ints_to_real ( integer(i8_kind), dimension(numint), intent(in) ints )

private

This function reverses the conversion in real_to_ints.

Definition at line 467 of file mpp_efp.F90.

◆ mpp_efp_assign()

subroutine mpp_efp_assign	(	type(mpp_efp_type), intent(out)	efp1,
		type(mpp_efp_type), intent(in)	efp2
	)

private

This subroutine assigns all components of the extended fixed point type variable on the RHS (EFP2) to the components of the variable on the LHS (EFP1).

Definition at line 617 of file mpp_efp.F90.

◆ mpp_efp_list_sum_across_pes()

subroutine, public mpp_efp_list_sum_across_pes	(	type(mpp_efp_type), dimension(:), intent(inout)	efps,
		integer, intent(in)	nval,
		logical, dimension(:), intent(out), optional	errors
	)

This subroutine does a sum across PEs of a list of EFP variables, returning the sums in place, with all overflows carried.

Definition at line 667 of file mpp_efp.F90.

◆ mpp_efp_minus()

type(mpp_efp_type) function, public mpp_efp_minus	(	type(mpp_efp_type), intent(in)	efp1,
		type(mpp_efp_type), intent(in)	efp2
	)

Definition at line 604 of file mpp_efp.F90.

◆ mpp_efp_plus()

type(mpp_efp_type) function, public mpp_efp_plus	(	type(mpp_efp_type), intent(in)	efp1,
		type(mpp_efp_type), intent(in)	efp2
	)

Definition at line 595 of file mpp_efp.F90.

◆ mpp_efp_real_diff()

real(r8_kind) function, public mpp_efp_real_diff	(	type(mpp_efp_type), intent(in)	efp1,
		type(mpp_efp_type), intent(in)	efp2
	)

Definition at line 633 of file mpp_efp.F90.

◆ mpp_efp_to_real()

real(r8_kind) function, public mpp_efp_to_real ( type(mpp_efp_type), intent(inout) efp1 )

Definition at line 625 of file mpp_efp.F90.

◆ mpp_query_efp_overflow_error()

logical function, public mpp_query_efp_overflow_error

Definition at line 586 of file mpp_efp.F90.

◆ mpp_real_to_efp()

type(mpp_efp_type) function, public mpp_real_to_efp	(	real(r8_kind), intent(in)	val,
		logical, intent(inout), optional	overflow
	)

Definition at line 644 of file mpp_efp.F90.

◆ mpp_reproducing_sum_r4_2d()

real(r4_kind) function mpp_reproducing_sum_r4_2d	(	real(r4_kind), dimension(:,:), intent(in)	array,
		integer, intent(in), optional	isr,
		integer, intent(in), optional	ier,
		integer, intent(in), optional	jsr,
		integer, intent(in), optional	jer,
		type(mpp_efp_type), intent(out), optional	efp_sum,
		logical, intent(in), optional	reproducing,
		logical, intent(in), optional	overflow_check,
		integer, intent(out), optional	err
	)

private

Returns: Result

Definition at line 243 of file mpp_efp.F90.

◆ mpp_reproducing_sum_r8_2d()

real(r8_kind) function mpp_reproducing_sum_r8_2d	(	real(r8_kind), dimension(:,:), intent(in)	array,
		integer, intent(in), optional	isr,
		integer, intent(in), optional	ier,
		integer, intent(in), optional	jsr,
		integer, intent(in), optional	jer,
		type(mpp_efp_type), intent(out), optional	efp_sum,
		logical, intent(in), optional	reproducing,
		logical, intent(in), optional	overflow_check,
		integer, intent(out), optional	err
	)

private

Calculates a reproducing sum for a 2D, 8-byte real array.

Returns: Result

Definition at line 102 of file mpp_efp.F90.

◆ mpp_reproducing_sum_r8_3d()

real(r8_kind) function mpp_reproducing_sum_r8_3d	(	real(r8_kind), dimension(:,:,:), intent(in)	array,
		integer, intent(in), optional	isr,
		integer, intent(in), optional	ier,
		integer, intent(in), optional	jsr,
		integer, intent(in), optional	jer,
		real(r8_kind), dimension(:), intent(out), optional	sums,
		type(mpp_efp_type), intent(out), optional	efp_sum,
		integer, intent(out), optional	err
	)

private

Reproducing sum for 3d arrays of 8-bit reals.

This function uses a conversion to an integer representation of real numbers to give order-invariant sums that will reproduce across PE count. This idea comes from R. Hallberg and A. Adcroft.

Returns: Result

Definition at line 269 of file mpp_efp.F90.

◆ mpp_reset_efp_overflow_error()

subroutine, public mpp_reset_efp_overflow_error

Definition at line 591 of file mpp_efp.F90.

◆ real_to_ints()

integer(i8_kind) function, dimension(numint) real_to_ints	(	real(r8_kind), intent(in)	r,
		integer(i8_kind), intent(in), optional	prec_error,
		logical, intent(inout), optional	overflow
	)

private

This function converts a real number to an equivalent representation using several long integers.

Definition at line 432 of file mpp_efp.F90.

◆ regularize_ints()

subroutine regularize_ints ( integer(i8_kind), dimension(numint), intent(inout) int_sum )

private

This subroutine carries the overflow, and then makes sure that all integers are of the same sign as the overall value.

Definition at line 551 of file mpp_efp.F90.

Variable Documentation

◆ debug

logical debug = .false.

private

Making this true enables debugging output.

Definition at line 60 of file mpp_efp.F90.

◆ i_pr

real(r8_kind), dimension(numint), parameter i_pr = (/ 1.0_8/r_prec**2, 1.0_8/r_prec, 1.0_8, r_prec, r_prec**2, r_prec**3 /)

private

Definition at line 56 of file mpp_efp.F90.

◆ i_prec

real(r8_kind), parameter i_prec =1.0_8/(2.0_8**NUMBIT)

private

The inverse of prec.

Definition at line 49 of file mpp_efp.F90.

◆ max_count_prec

integer, parameter max_count_prec =2**(63-NUMBIT)-1

private

The number of values that can be added together with the current value of prec before there will be roundoff problems.

Definition at line 50 of file mpp_efp.F90.

◆ nan_error

logical nan_error = .false.

private

Definition at line 59 of file mpp_efp.F90.

◆ numint

integer, parameter numint = 6

private

The number of long integers to use to represent a real number.

Definition at line 44 of file mpp_efp.F90.

◆ overflow_error

logical overflow_error = .false.

private

Definition at line 59 of file mpp_efp.F90.

◆ pr

real(r8_kind), dimension(numint), parameter pr = (/ r_prec**2, r_prec, 1.0_8, 1.0_8/r_prec, 1.0_8/r_prec**2, 1.0_8/r_prec**3 /)

private

Definition at line 54 of file mpp_efp.F90.

◆ prec

integer(i8_kind), parameter prec =2_8**NUMBIT

private

The precision of each integer.

Definition at line 47 of file mpp_efp.F90.

◆ r_prec

real(r8_kind), parameter r_prec =2.0_8**NUMBIT

private

A real version of prec.

Definition at line 48 of file mpp_efp.F90.

Data Types

Functions/Subroutines

Variables

Detailed Description

Data Type Documentation

◆ mpp_efp_mod::assignment(=)

Public Member Functions

Member Function/Subroutine Documentation

◆ mpp_efp_assign()

◆ mpp_efp_mod::mpp_efp_type

Private Attributes

Member Data Documentation

◆ v

◆ mpp_efp_mod::mpp_reproducing_sum

Public Member Functions

Member Function/Subroutine Documentation

◆ mpp_reproducing_sum_r4_2d()

◆ mpp_reproducing_sum_r8_2d()

◆ mpp_reproducing_sum_r8_3d()

◆ mpp_efp_mod::operator(+)

Public Member Functions

Member Function/Subroutine Documentation

◆ mpp_efp_plus()

◆ mpp_efp_mod::operator(-)

Public Member Functions

Member Function/Subroutine Documentation

◆ mpp_efp_minus()

Function/Subroutine Documentation

◆ carry_overflow()

◆ increment_ints()

◆ increment_ints_faster()

◆ ints_to_real()

◆ mpp_efp_assign()

◆ mpp_efp_list_sum_across_pes()

◆ mpp_efp_minus()

◆ mpp_efp_plus()

◆ mpp_efp_real_diff()

◆ mpp_efp_to_real()

◆ mpp_query_efp_overflow_error()

◆ mpp_real_to_efp()

◆ mpp_reproducing_sum_r4_2d()

◆ mpp_reproducing_sum_r8_2d()

◆ mpp_reproducing_sum_r8_3d()

◆ mpp_reset_efp_overflow_error()

◆ real_to_ints()

◆ regularize_ints()

Variable Documentation

◆ debug

◆ i_pr

◆ i_prec

◆ max_count_prec

◆ nan_error

◆ numint

◆ overflow_error

◆ pr

◆ prec

◆ r_prec