Type | Visibility | Attributes | Name | Initial | |||
---|---|---|---|---|---|---|---|
real(kind=prec), | public | :: | dt | ||||
real(kind=prec), | public | :: | entropy | ||||
logical, | public | :: | gradient_enabled | = | .false. | ||
integer, | public | :: | ioIterate | = | 0 | ||
integer, | public | :: | nvar | ||||
logical, | public | :: | prescribed_bcs_enabled | = | .true. | ||
real(kind=prec), | public | :: | t | ||||
logical, | public | :: | tecplot_enabled | = | .true. | ||
procedure(SELF_timeIntegrator), | public, | pointer | :: | timeIntegrator | => | Euler_timeIntegrator |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
integer(kind=HID_T), | intent(in) | :: | fileid |
Base method for calculating entropy of a model When this method is not overridden, the entropy is simply set to 0.0. When you develop a model built on top of this abstract class or one of its children, it is recommended that you define a convex mathematical entropy function that is used as a measure of the model stability.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
real(kind=prec), | intent(in) | :: | tn |
Forward steps the model using the associated tendency procedure and time integrator
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
real(kind=prec), | intent(in) | :: | tn | |||
real(kind=prec), | intent(in) | :: | dt | |||
real(kind=prec), | intent(in) | :: | ioInterval |
Returns the current simulation time stored in the model % t attribute
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(out) | :: | t |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
real(kind=prec), | intent(in) | :: | tn |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
real(kind=prec), | intent(in) | :: | tn |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
real(kind=prec), | intent(in) | :: | tn |
PreTendency is a template routine that is used to house any additional calculations that you want to execute at the beginning of the tendency calculation routine. This default PreTendency simply returns back to the caller without executing any instructions
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
character, | intent(in) | :: | filename |
Base method for reporting the entropy of a model to stdout. Only override this procedure if additional reporting is needed. Alternatively, if you think additional reporting would be valuable for all models, open a pull request with modifications to this base method.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this |
Method that can be overridden by users to report their own custom metrics after file io
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Method that can be overridden by users to report their own custom metrics after file io
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this |
Sets the model % t attribute with the provided simulation time
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
real(kind=prec), | intent(in) | :: | t |
Sets the time integrator method, using a character input
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
character, | intent(in) | :: | integrator |
Sets the time integrator method, using a character input
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
character, | intent(in) | :: | integrator |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
integer, | intent(in) | :: | m |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
integer, | intent(in) | :: | m |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
integer, | intent(in) | :: | m |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
real(kind=prec), | intent(in), | optional | :: | dt |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
character, | intent(in), | optional | :: | filename |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(inout) | :: | this | |||
character, | intent(in), | optional | :: | filename |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:2) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:3) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | x | |||
real(kind=prec), | intent(in) | :: | t |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat(1:2) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | x(1:2) | |||
real(kind=prec), | intent(in) | :: | t |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat(1:2) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat(1:3) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | x(1:3) | |||
real(kind=prec), | intent(in) | :: | t |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat(1:3) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | x | |||
real(kind=prec), | intent(in) | :: | t |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:2) | |||
real(kind=prec), | intent(in) | :: | nhat(1:2) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | x(1:2) | |||
real(kind=prec), | intent(in) | :: | t |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:2) | |||
real(kind=prec), | intent(in) | :: | nhat(1:2) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:3) | |||
real(kind=prec), | intent(in) | :: | nhat(1:3) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | x(1:3) | |||
real(kind=prec), | intent(in) | :: | t |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:3) | |||
real(kind=prec), | intent(in) | :: | nhat(1:3) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | sL(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | sR(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | nhat |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | sL(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | sR(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:2) | |||
real(kind=prec), | intent(in) | :: | nhat(1:2) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | sL(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | sR(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:3) | |||
real(kind=prec), | intent(in) | :: | nhat(1:3) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:2) |
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Model), | intent(in) | :: | this | |||
real(kind=prec), | intent(in) | :: | s(1:this%nvar) | |||
real(kind=prec), | intent(in) | :: | dsdx(1:this%nvar,1:3) |
type,abstract :: Model
! Time integration attributes
procedure(SELF_timeIntegrator),pointer :: timeIntegrator => Euler_timeIntegrator
real(prec) :: dt
real(prec) :: t
integer :: ioIterate = 0
logical :: gradient_enabled = .false.
logical :: prescribed_bcs_enabled = .true.
logical :: tecplot_enabled = .true.
integer :: nvar
! Standard Diagnostics
real(prec) :: entropy ! Mathematical entropy function for the model
contains
procedure :: IncrementIOCounter
procedure :: PrintType => PrintType_Model
procedure :: SetNumberOfVariables => SetNumberOfVariables_Model
procedure :: AdditionalInit => AdditionalInit_Model
procedure :: AdditionalFree => AdditionalFree_Model
procedure :: AdditionalOutput => AdditionalOutput_Model
procedure :: ForwardStep => ForwardStep_Model
procedure :: Euler_timeIntegrator
! Runge-Kutta methods
procedure :: LowStorageRK2_timeIntegrator
procedure(UpdateGRK),deferred :: UpdateGRK2
procedure :: LowStorageRK3_timeIntegrator
procedure(UpdateGRK),deferred :: UpdateGRK3
procedure :: LowStorageRK4_timeIntegrator
procedure(UpdateGRK),deferred :: UpdateGRK4
procedure :: PreTendency => PreTendency_Model
procedure :: entropy_func => entropy_func_Model
procedure :: flux1D => flux1d_Model
procedure :: flux2D => flux2d_Model
procedure :: flux3D => flux3d_Model
procedure :: riemannflux1d => riemannflux1d_Model
procedure :: riemannflux2d => riemannflux2d_Model
procedure :: riemannflux3d => riemannflux3d_Model
procedure :: source1d => source1d_Model
procedure :: source2d => source2d_Model
procedure :: source3d => source3d_Model
! Boundary condition functions (hyperbolic)
procedure :: hbc1d_Prescribed => hbc1d_Prescribed_Model
procedure :: hbc1d_Radiation => hbc1d_Generic_Model
procedure :: hbc1d_NoNormalFlow => hbc1d_Generic_Model
procedure :: hbc2d_Prescribed => hbc2d_Prescribed_Model
procedure :: hbc2d_Radiation => hbc2d_Generic_Model
procedure :: hbc2d_NoNormalFlow => hbc2d_Generic_Model
procedure :: hbc3d_Prescribed => hbc3d_Prescribed_Model
procedure :: hbc3d_Radiation => hbc3d_Generic_Model
procedure :: hbc3d_NoNormalFlow => hbc3d_Generic_Model
! Boundary condition functions (parabolic)
procedure :: pbc1d_Prescribed => pbc1d_Prescribed_Model
procedure :: pbc1d_Radiation => pbc1d_Generic_Model
procedure :: pbc1d_NoNormalFlow => pbc1d_Generic_Model
procedure :: pbc2d_Prescribed => pbc2d_Prescribed_Model
procedure :: pbc2d_Radiation => pbc2d_Generic_Model
procedure :: pbc2d_NoNormalFlow => pbc2d_Generic_Model
procedure :: pbc3d_Prescribed => pbc3d_Prescribed_Model
procedure :: pbc3d_Radiation => pbc3d_Generic_Model
procedure :: pbc3d_NoNormalFlow => pbc3d_Generic_Model
procedure :: ReportEntropy => ReportEntropy_Model
procedure :: ReportMetrics => ReportMetrics_Model
procedure :: ReportUserMetrics => ReportUserMetrics_Model
procedure :: CalculateEntropy => CalculateEntropy_Model
procedure(UpdateSolution),deferred :: UpdateSolution
procedure(CalculateTendency),deferred :: CalculateTendency
procedure(ReadModel),deferred :: ReadModel
procedure(WriteModel),deferred :: WriteModel
procedure(WriteTecplot),deferred :: WriteTecplot
generic :: SetTimeIntegrator => SetTimeIntegrator_withChar
procedure,private :: SetTimeIntegrator_withChar
procedure :: SetSimulationTime
procedure :: GetSimulationTime
endtype Model