CalculationTree Derived Type

type, public, extends(Object) :: CalculationTree


Components

Type Visibility Attributes Name Initial
logical, public :: userDefined = .false.

True only if user explicitly sets it to true
type(CalculationNode), public, pointer :: root => null()

Finalization Procedures

final :: finalizeCalculationTree


Type-Bound Procedures

procedure, public :: isDefined => isDefinedObject

  • interface

    private pure module function isDefinedObject(this) result(defined)

    Getter for userDefined

    Arguments

    Type IntentOptional Attributes Name
    class(Object), intent(in) :: this

    Return Value logical

procedure, public :: makeDefined => makeDefinedObject

  • interface

    private pure module subroutine makeDefinedObject(this)

    Set userDefined to .true.

    Arguments

    Type IntentOptional Attributes Name
    class(Object), intent(inout) :: this

procedure, public :: makeUndefined => makeUndefinedObject

  • interface

    private pure module subroutine makeUndefinedObject(this)

    Set userDefined to .false.

    Arguments

    Type IntentOptional Attributes Name
    class(Object), intent(inout) :: this

procedure, public :: init => initTree

  • interface

    public module subroutine initTree(this, additiveMode, constant, leafVarIndex, unaryRealParams, unaryIntParams, unaryLogicalParams, unaryTransformTag)

    Calculation tree initialization routine

    Arguments

    Type IntentOptional Attributes Name
    class(CalculationTree), intent(inout) :: this
    logical, intent(in), optional :: additiveMode
    real(kind=rk), intent(in), optional :: constant
    integer(kind=ik), intent(in), optional :: leafVarIndex
    real(kind=rk), intent(in), optional, dimension(:) :: unaryRealParams
    integer(kind=ik), intent(in), optional, dimension(:) :: unaryIntParams
    logical, intent(in), optional, dimension(:) :: unaryLogicalParams
    character(len=*), intent(in), optional :: unaryTransformTag

procedure, public :: evaluate => evaluateTree

  • interface

    public pure module function evaluateTree(this, inputArray) result(res)

    Call tree's root node evaluate

    Arguments

    Type IntentOptional Attributes Name
    class(CalculationTree), intent(in) :: this
    type(RealArray), intent(in), dimension(:) :: inputArray

    Return Value real(kind=rk), allocatable, dimension(:)

procedure, public :: flatten => flattenTree

  • interface

    public module function flattenTree(this) result(res)

    Flatten tree into FlatTree object

    Arguments

    Type IntentOptional Attributes Name
    class(CalculationTree), intent(in) :: this

    Return Value type(FlatTree)

procedure, public :: initFromFlatTree

  • interface

    public module subroutine initFromFlatTree(this, fTree)

    Calculation tree initialization routine using a FlatTree object

    Arguments

    Type IntentOptional Attributes Name
    class(CalculationTree), intent(inout) :: this
    type(FlatTree), intent(in) :: fTree