SELF_SupportRoutines Module

\file SELF_SupportRoutines.f90 Contains the \ref SELF_SupportRoutines module \defgroup SELF_SupportRoutines SELF_SupportRoutines This module defines a set of general purpose routines.



Contents


Variables

TypeVisibilityAttributesNameInitial
real(kind=prec), private, parameter:: tolerance =10.0**(-10)

Interfaces

public interface AlmostEqual

  • public function AlmostEqual_r64(a, b) result(AisB)

    \addtogroup SELF_SupportRoutines @{ \fn AlmostEqual Compares two floating point numbers and determines if they are equal (to machine precision).

    Read more…

    Arguments

    TypeIntentOptionalAttributesName
    real(kind=real64) :: a
    real(kind=real64) :: b

    Return Value logical


Functions

public function AlmostEqual_r64(a, b) result(AisB)

\addtogroup SELF_SupportRoutines @{ \fn AlmostEqual Compares two floating point numbers and determines if they are equal (to machine precision).

Read more…

Arguments

TypeIntentOptionalAttributesName
real(kind=real64) :: a
real(kind=real64) :: b

Return Value logical

public function CompareArray(arrayOne, arrayTwo, N) result(arraysMatch)

\addtogroup SELF_SupportRoutines @{ \fn CompareArray Compares to INTEGER arrays and determines if they are identical.

Read more…

Arguments

TypeIntentOptionalAttributesName
integer :: arrayOne(1:N)
integer :: arrayTwo(1:N)
integer :: N

Return Value logical

public function UniformPoints(a, b, firstInd, lastInd) result(xU)

\addtogroup SELF_SupportRoutines @{ \fn UniformPoints Generates a REAL(prec) array of N points evenly spaced between two points.

Read more…

Arguments

TypeIntentOptionalAttributesName
real(kind=prec) :: a
real(kind=prec) :: b
integer :: firstInd
integer :: lastInd

Return Value real(kind=prec)(firstInd:lastInd)

public function UpperCase(str) result(Upper)

Arguments

TypeIntentOptionalAttributesName
character, intent(in) :: str

Return Value character

public function newunit(unit)

Arguments

TypeIntentOptionalAttributesName
integer, intent(out), optional :: unit

Return Value integer


Subroutines

public subroutine ForwardShift(myArray, N)

\addtogroup SELF_SupportRoutines @{ \fn ForwardShift Shift an array integers by one index forward, moving the last index to the first.

Read more…

Arguments

TypeIntentOptionalAttributesName
integer, intent(inout) :: myArray(1:N)
integer, intent(in) :: N