jagged_array_generator_class Module

Houses abstract class defining an interface for the calculation of jagged real arrays used in matrix construction based on variable data


Uses

Used by


Interfaces

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(:)


Abstract Interfaces

abstract interface

  • private subroutine calculateStencilValsInPlace(this, varCont, res, mbData, hostModel)

    Calculate stencil values in place (a RealArray that can be used as a multConst for a MatrixTerm)

    Arguments

    Type IntentOptional Attributes Name
    class(JaggedArrayGenerator), 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

Derived Types

type, public, abstract, extends(Object) ::  JaggedArrayGenerator

JaggedArrayGenerator object for calculating jagged real arrays based on variable data

Components

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

True only if user explicitly sets it to true

Type-Bound Procedures

procedure, public :: isDefined => isDefinedObject
procedure, public :: makeDefined => makeDefinedObject
procedure, public :: makeUndefined => makeUndefinedObject
procedure(calculateStencilValsInPlace), public, deferred :: calculateInPlace
procedure, public :: calculate