EnvironmentWrapper Derived Type
type, public, extends(Object) :: EnvironmentWrapper
EnvironmentWrapper object storing publicly accessible grid, variable, and controller data
Components
| Type | Visibility | Attributes | Name | Initial | |||
|---|---|---|---|---|---|---|---|
| logical, | public | :: | userDefined | = | .false. |
True only if user explicitly sets it to true |
|
| type(Grid), | public | :: | gridObj | ||||
| type(Geometry), | public | :: | geometryObj | ||||
| type(Partition), | public | :: | partitionObj | ||||
| type(Indexing), | public | :: | indexingObj | ||||
| type(VSpace), | public | :: | vSpaceObj | ||||
| type(MPIController), | public | :: | mpiCont | ||||
| type(JSONController), | public, | pointer | :: | jsonCont | => | null() | |
| type(HDF5Controller), | public | :: | hdf5Cont | ||||
| type(PETScController), | public, | allocatable | :: | petscCont | |||
| type(Textbook), | public | :: | textbookObj | ||||
| type(SpeciesList), | public | :: | speciesListObj | ||||
| type(SignalCollection), | public | :: | signalCollectionObj | ||||
| type(VariableContainer), | public | :: | externalVars | ||||
| type(VariableList), | public | :: | allVars |
Finalization Procedures
Type-Bound Procedures
procedure, public :: isDefined => isDefinedObject
-
interface
private pure module function isDefinedObject(this) result(defined)
Getter for userDefined
Arguments
Type Intent Optional 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 Intent Optional Attributes Name class(Object), intent(inout) :: this
procedure, public :: makeUndefined => makeUndefinedObject
-
interface
private pure module subroutine makeUndefinedObject(this)
Set userDefined to .false.
Arguments
Type Intent Optional Attributes Name class(Object), intent(inout) :: this
procedure, public :: init => initEnvironmentFromJSON
-
interface
private module subroutine initEnvironmentFromJSON(this, textbookObj, normObj)
Initialize environment using data from config.json and textbook object for initializing external variables. Also initializes the status_printing module. If the textbook is not supplied the envirnment is not considered defined and finishInit must be called before the environment is passed around.
Arguments
Type Intent Optional Attributes Name class(EnvironmentWrapper), intent(inout) :: this type(Textbook), intent(in), optional :: textbookObj Textbook object used to retrieve derivation rules for variable container
class(Normalization), intent(in), optional :: normObj Normalization object used to retrieve grid normalization. If not present grid is assumed normalized
procedure, public :: finishInit
-
interface
private module subroutine finishInit(this, textbookObj)
Finalize the initialization of the environment by setting the textbook object and performing initializations that require it
Arguments
Type Intent Optional Attributes Name class(EnvironmentWrapper), intent(inout) :: this type(Textbook), intent(in) :: textbookObj Textbook object used to retrieve derivation rules for variable container