MultiplicativeStencilGen Derived Type

type, public, extends(JaggedArrayGenerator) :: MultiplicativeStencilGen

Generates stencil values based on independent data for x,h,v dimensions


Components

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

True only if user explicitly sets it to true
type(MultiplicativeGeneratorCore), private, allocatable :: core

Calculation core generated using stencil and rowCoord data
class(JaggedArrayGenerator), private, allocatable :: xStencilGen

Optional x stencil generator
class(JaggedArrayGenerator), private, allocatable :: hStencilGen

Optional harmonic stencil generator
class(JaggedArrayGenerator), private, allocatable :: vStencilGen

Optional velocity space stencil generator
type(RealArray), private, allocatable, dimension(:) :: xVals

Buffer for x stencil values
type(RealArray), private, allocatable, dimension(:) :: hVals

Buffer for h stencil values
type(RealArray), private, allocatable, dimension(:) :: vVals

Buffer for v stencil values
logical, private :: fluidCol

True if the column variable is fluid. Defaults to false.

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 :: calculate

  • interface

    private module function calculate(this, varCont, mbData, hostModel) result(res)

    Use in place version of stencil calculation to return values

    Arguments

    Type IntentOptional Attributes Name
    class(JaggedArrayGenerator), intent(inout) :: this
    type(VariableContainer), intent(in) :: varCont
    class(ModelboundData), intent(in), optional :: mbData
    class(ModelSurrogate), intent(in), optional :: hostModel

    Return Value type(RealArray), allocatable, dimension(:)

procedure, public :: init => initMultGen

  • interface

    private module subroutine initMultGen(this, coreObj, fluidCol, initXVals, initHVals, initVVals)

    Multiplicative stencil value generator initialization routine

    Arguments

    Type IntentOptional Attributes Name
    class(MultiplicativeStencilGen), intent(inout) :: this
    type(MultiplicativeGeneratorCore), intent(inout), allocatable :: coreObj

    Multiplicative core - will be deallocated after call
    logical, intent(in), optional :: fluidCol

    True if the column variable for this stencil is fluid.

    type(RealArray), intent(in), optional, dimension(:) :: initXVals

    Optional initial raw x stencil values. Defaults to unallocated.

    type(RealArray), intent(in), optional, dimension(:) :: initHVals

    Optional initial raw h stencil values. Defaults to unallocated.

    type(RealArray), intent(in), optional, dimension(:) :: initVVals

    Optional initial raw v stencil values. Defaults to unallocated.

procedure, public :: calculateInPlace => calcMultVals

  • interface

    private module subroutine calcMultVals(this, varCont, res, mbData, hostModel)

    Calculate multiplicative stencil values in place

    Arguments

    Type IntentOptional Attributes Name
    class(MultiplicativeStencilGen), intent(inout) :: this
    type(VariableContainer), intent(in) :: varCont
    type(RealArray), intent(inout), allocatable, dimension(:) :: res
    class(ModelboundData), intent(in), optional :: mbData
    class(ModelSurrogate), intent(in), optional :: hostModel

procedure, public :: setXGen

procedure, public :: setHGen

procedure, public :: setVGen