textbook_class Module

Houses class containing named derivation rules


Uses

Used by


Interfaces

interface

  • private pure module function isDerivationRegistered(this, name) result(reg)

    Check whether derivation with given name is registered in the textbook

    Arguments

    Type IntentOptional Attributes Name
    class(Textbook), intent(in) :: this
    character(len=*), intent(in) :: name

    Return Value logical

interface

  • private pure module function isMatDerivationRegistered(this, name) result(reg)

    Check whether matrix derivation with given name is registered in the textbook

    Arguments

    Type IntentOptional Attributes Name
    class(Textbook), intent(in) :: this
    character(len=*), intent(in) :: name

    Return Value logical

interface

  • private pure module subroutine initTextbook(this)

    Textbook object initialization

    Arguments

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

interface

  • private pure module subroutine addDerivation(this, deriv, name)

    Add derivation object to textbook

    Arguments

    Type IntentOptional Attributes Name
    class(Textbook), intent(inout) :: this
    class(Derivation), intent(in) :: deriv
    character(len=*), intent(in) :: name

interface

  • private pure module subroutine copyDerivation(this, name, deriv)

    Copy derivation with given name into passed deriv object, overwriting any existing derivation

    Arguments

    Type IntentOptional Attributes Name
    class(Textbook), intent(in) :: this
    character(len=*), intent(in) :: name
    class(Derivation), intent(inout), allocatable :: deriv

interface

  • private pure module subroutine addMatDerivation(this, deriv, name)

    Add matrix derivation object to textbook

    Arguments

    Type IntentOptional Attributes Name
    class(Textbook), intent(inout) :: this
    class(MatDerivation), intent(in) :: deriv
    character(len=*), intent(in) :: name

interface

  • private pure module subroutine copyMatDerivation(this, name, deriv)

    Copy matrix derivation with given name into passed deriv object, overwriting any existing derivation

    Arguments

    Type IntentOptional Attributes Name
    class(Textbook), intent(in) :: this
    character(len=*), intent(in) :: name
    class(MatDerivation), intent(inout), allocatable :: deriv

Derived Types

type, public, extends(Object) ::  Textbook

Object storing named derivations

Components

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

True only if user explicitly sets it to true
type(DerivationContainer), private, allocatable, dimension(:) :: derivations
type(StringArray), private, allocatable, dimension(:) :: derivationNames
type(MatDerivationContainer), private, allocatable, dimension(:) :: matDerivations
type(StringArray), private, allocatable, dimension(:) :: matDerivationNames

Type-Bound Procedures

procedure, public :: isDefined => isDefinedObject
procedure, public :: makeDefined => makeDefinedObject
procedure, public :: makeUndefined => makeUndefinedObject
procedure, public :: addDerivation
procedure, public :: isDerivationRegistered
procedure, public :: copyDerivation
procedure, public :: addMatDerivation
procedure, public :: isMatDerivationRegistered
procedure, public :: copyMatDerivation
procedure, public :: init => initTextbook