FMS  2024.01.00
Flexible Modeling System
fms_diag_elem_weight_procs_mod

fms_diag_elem_weight_procs_mod Contains elemental functions for uddating one element of a buffer array with field data. More...

Data Types

interface  addwf
 Interface for the elemental function addwf, which Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value. More...
 

Functions/Subroutines

elemental integer(i4_kind) function addwf_i4 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental integer(i4_kind) function addwf_i4 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental integer(i8_kind) function addwf_i8 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental integer(i8_kind) function addwf_i8 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental real(r4_kind) function addwf_r4 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental real(r4_kind) function addwf_r4 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental real(r8_kind) function addwf_r8 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental real(r8_kind) function addwf_r8 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 

Detailed Description

fms_diag_elem_weight_procs_mod Contains elemental functions for uddating one element of a buffer array with field data.

Author
Miguel Zuniga

fms_diag_elem_weight_procs_mod Contains elemental functions for uddating one element of a buffer array with field data,


Data Type Documentation

◆ fms_diag_elem_weight_procs_mod::addwf

interface fms_diag_elem_weight_procs_mod::addwf

Interface for the elemental function addwf, which Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value.

Definition at line 43 of file fms_diag_elem_weight_procs.F90.

Public Member Functions

elemental integer(i4_kind) function addwf_i4 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental integer(i8_kind) function addwf_i8 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental real(r4_kind) function addwf_r4 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 
elemental real(r8_kind) function addwf_r8 (buff, field, weight, pow_value)
 Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function. More...
 

Function/Subroutine Documentation

◆ addwf_i4() [1/2]

elemental integer(i4_kind) function addwf_i4 ( integer(i4_kind), intent(in)  buff,
integer(i4_kind), intent(in)  field,
integer, intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 100 of file fms_diag_elem_weight_procs.F90.

◆ addwf_i4() [2/2]

elemental integer(i4_kind) function fms_diag_elem_weight_procs_mod::addwf_i4 ( integer(i4_kind), intent(in)  buff,
integer(i4_kind), intent(in)  field,
integer, intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 100 of file fms_diag_elem_weight_procs.F90.

◆ addwf_i8() [1/2]

elemental integer(i8_kind) function addwf_i8 ( integer(i8_kind), intent(in)  buff,
integer(i8_kind), intent(in)  field,
integer, intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 118 of file fms_diag_elem_weight_procs.F90.

◆ addwf_i8() [2/2]

elemental integer(i8_kind) function fms_diag_elem_weight_procs_mod::addwf_i8 ( integer(i8_kind), intent(in)  buff,
integer(i8_kind), intent(in)  field,
integer, intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 118 of file fms_diag_elem_weight_procs.F90.

◆ addwf_r4() [1/2]

elemental real(r4_kind) function fms_diag_elem_weight_procs_mod::addwf_r4 ( real(r4_kind), intent(in)  buff,
real(r4_kind), intent(in)  field,
real(r4_kind), intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 62 of file fms_diag_elem_weight_procs.F90.

◆ addwf_r4() [2/2]

elemental real(r4_kind) function addwf_r4 ( real(r4_kind), intent(in)  buff,
real(r4_kind), intent(in)  field,
real(r4_kind), intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 62 of file fms_diag_elem_weight_procs.F90.

◆ addwf_r8() [1/2]

elemental real(r8_kind) function addwf_r8 ( real(r8_kind), intent(in)  buff,
real(r8_kind), intent(in)  field,
real(r8_kind), intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 81 of file fms_diag_elem_weight_procs.F90.

◆ addwf_r8() [2/2]

elemental real(r8_kind) function fms_diag_elem_weight_procs_mod::addwf_r8 ( real(r8_kind), intent(in)  buff,
real(r8_kind), intent(in)  field,
real(r8_kind), intent(in)  weight,
integer, intent(in)  pow_value 
)

Calculates and returns the value given by this formula: returned_value = buff + (weight * field)**pow_value Special cases when pow_value is equal to 1 or 2 do not explicitly use the power function.

Parameters
[in]buffThe buffer cell (point) value
[in]fieldThe field value
[in]weightThe weight factor for the field
[in]pow_valueThe power value for the power function

Definition at line 81 of file fms_diag_elem_weight_procs.F90.