MFC
Exascale flow solver
Loading...
Searching...
No Matches
m_helper_basic Module Reference

Basic floating-point utilities: approximate equality, default detection, and coordinate bounds. More...

Functions/Subroutines

logical elemental function, public f_approx_equal (a, b, tol_input)
 Check if two floating point numbers of wp are within tolerance.
logical function, public f_approx_in_array (a, b, tol_input)
 Check if a wp value approximately matches any element of an array within tolerance.
logical elemental function, public f_is_default (var)
 Checks if a real(wp) variable is of default value.
logical function, public f_all_default (var_array)
 Checks if ALL elements of a real(wp) array are of default value.
logical elemental function, public f_is_integer (var)
 Checks if a real(wp) variable is an integer.
subroutine, public s_configure_coordinate_bounds (recon_type, weno_polyn, muscl_polyn, igr_order, buff_size, idwint, idwbuff, viscous, bubbles_lagrange, m, n, p, num_dims, igr, ib)
 Compute ghost-cell buffer size and set interior/buffered coordinate index bounds.
elemental subroutine, public s_update_cell_bounds (bounds, m, n, p)
 Updates the min and max number of cells in each set of axes.

Detailed Description

Basic floating-point utilities: approximate equality, default detection, and coordinate bounds.

Function/Subroutine Documentation

◆ f_all_default()

logical function, public m_helper_basic::f_all_default ( real(wp), dimension(:), intent(in) var_array)

Checks if ALL elements of a real(wp) array are of default value.

Definition at line 435 of file m_helper_basic.fpp.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ f_approx_equal()

logical elemental function, public m_helper_basic::f_approx_equal ( real(wp), intent(in) a,
real(wp), intent(in) b,
real(wp), intent(in), optional tol_input )

Check if two floating point numbers of wp are within tolerance.

Parameters
tol_inputRelative error (default = 1.e-10_wp).

Definition at line 331 of file m_helper_basic.fpp.f90.

Here is the caller graph for this function:

◆ f_approx_in_array()

logical function, public m_helper_basic::f_approx_in_array ( real(wp), intent(in) a,
real(wp), dimension(:), intent(in) b,
real(wp), intent(in), optional tol_input )

Check if a wp value approximately matches any element of an array within tolerance.

Parameters
tol_inputRelative error (default = 1e-10_wp).

Definition at line 370 of file m_helper_basic.fpp.f90.

Here is the call graph for this function:

◆ f_is_default()

logical elemental function, public m_helper_basic::f_is_default ( real(wp), intent(in) var)

Checks if a real(wp) variable is of default value.

Definition at line 411 of file m_helper_basic.fpp.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ f_is_integer()

logical elemental function, public m_helper_basic::f_is_integer ( real(wp), intent(in) var)

Checks if a real(wp) variable is an integer.

Definition at line 444 of file m_helper_basic.fpp.f90.

Here is the call graph for this function:

◆ s_configure_coordinate_bounds()

subroutine, public m_helper_basic::s_configure_coordinate_bounds ( integer, intent(in) recon_type,
integer, intent(in) weno_polyn,
integer, intent(in) muscl_polyn,
integer, intent(in) igr_order,
integer, intent(inout) buff_size,
type(int_bounds_info), dimension(3), intent(inout) idwint,
type(int_bounds_info), dimension(3), intent(inout) idwbuff,
logical, intent(in) viscous,
logical, intent(in) bubbles_lagrange,
integer, intent(in) m,
integer, intent(in) n,
integer, intent(in) p,
integer, intent(in) num_dims,
logical, intent(in) igr,
logical, intent(in) ib )

Compute ghost-cell buffer size and set interior/buffered coordinate index bounds.

Definition at line 468 of file m_helper_basic.fpp.f90.

Here is the caller graph for this function:

◆ s_update_cell_bounds()

elemental subroutine, public m_helper_basic::s_update_cell_bounds ( type(cell_num_bounds), intent(out) bounds,
integer, intent(in) m,
integer, intent(in) n,
integer, intent(in) p )

Updates the min and max number of cells in each set of axes.

Parameters
boundsMin and max values to update

Definition at line 519 of file m_helper_basic.fpp.f90.

Here is the caller graph for this function: