ECAdvection3D Derived Type

  1. SELF_ECAdvection3D.f90
  2. SELF_ECAdvection3D
  3. ECAdvection3D

type, public, extends(ECAdvection3D_t) :: ECAdvection3D


Inherits

type~~ecadvection3d~2~~InheritsGraph type~ecadvection3d~2 ECAdvection3D type~ecadvection3d_t ECAdvection3D_t type~ecadvection3d~2->type~ecadvection3d_t type~ecdgmodel3d_t ECDGModel3D_t type~ecadvection3d_t->type~ecdgmodel3d_t type~mappedtwopointvector3d MappedTwoPointVector3D type~ecdgmodel3d_t->type~mappedtwopointvector3d twoPointFlux type~dgmodel3d_t DGModel3D_t type~ecdgmodel3d_t->type~dgmodel3d_t type~mappedtwopointvector3d_t MappedTwoPointVector3D_t type~mappedtwopointvector3d->type~mappedtwopointvector3d_t type~semhex SEMHex type~dgmodel3d_t->type~semhex geometry type~mesh3d Mesh3D type~dgmodel3d_t->type~mesh3d mesh type~mappedvector3d MappedVector3D type~dgmodel3d_t->type~mappedvector3d solutionGradient, flux type~mappedscalar3d MappedScalar3D type~dgmodel3d_t->type~mappedscalar3d solution, source, fluxDivergence, dSdt, workSol type~boundaryconditionlist BoundaryConditionList type~dgmodel3d_t->type~boundaryconditionlist hyperbolicBCs, parabolicBCs type~model Model type~dgmodel3d_t->type~model type~vector3d Vector3D type~semhex->type~vector3d x, nHat type~tensor3d Tensor3D type~semhex->type~tensor3d dxds, dsdx type~scalar3d Scalar3D type~semhex->type~scalar3d nScale, J type~mesh3d_t Mesh3D_t type~mesh3d->type~mesh3d_t type~mappedtwopointvector3d_t->type~semhex geometry type~twopointvector3d TwoPointVector3D type~mappedtwopointvector3d_t->type~twopointvector3d type~mappedvector3d_t MappedVector3D_t type~mappedvector3d->type~mappedvector3d_t type~mappedscalar3d_t MappedScalar3D_t type~mappedscalar3d->type~mappedscalar3d_t type~boundarycondition BoundaryCondition type~boundaryconditionlist->type~boundarycondition current, head, tail type~vector3d_t Vector3D_t type~vector3d->type~vector3d_t type~tensor3d_t Tensor3D_t type~tensor3d->type~tensor3d_t type~twopointvector3d_t TwoPointVector3D_t type~twopointvector3d->type~twopointvector3d_t type~mappedscalar3d_t->type~semhex geometry type~mappedscalar3d_t->type~scalar3d type~semmesh SEMMesh type~mesh3d_t->type~semmesh type~scalar3d_t Scalar3D_t type~scalar3d->type~scalar3d_t type~mappedvector3d_t->type~semhex geometry type~mappedvector3d_t->type~vector3d type~boundarycondition->type~boundarycondition next, prev c_ptr c_ptr type~boundarycondition->c_ptr elements_gpu, sides_gpu type~self_dataobj SELF_DataObj type~scalar3d_t->type~self_dataobj type~domaindecomposition DomainDecomposition type~semmesh->type~domaindecomposition decomp type~twopointvector3d_t->type~self_dataobj type~vector3d_t->type~self_dataobj type~tensor3d_t->type~self_dataobj type~lagrange Lagrange type~self_dataobj->type~lagrange interp type~metadata Metadata type~self_dataobj->type~metadata meta EquationParser EquationParser type~self_dataobj->EquationParser eqn type~domaindecomposition_t DomainDecomposition_t type~domaindecomposition->type~domaindecomposition_t type~lagrange_t Lagrange_t type~lagrange->type~lagrange_t type~lagrange_t->c_ptr blas_handle

Contents

Variables

Type-Bound Procedures

Source Code

ECAdvection3D

Components

TypeVisibilityAttributesNameInitial
type(MappedScalar3D), public :: dSdt
real(kind=prec), public :: dt
real(kind=prec), public :: entropy
type(MappedVector3D), public :: flux
type(MappedScalar3D), public :: fluxDivergence
type(SEMHex), public, pointer:: geometry
logical, public :: gradient_enabled =.false.
type(BoundaryConditionList), public :: hyperbolicBCs
integer, public :: ioIterate =0
type(Mesh3D), public, pointer:: mesh
integer, public :: nvar
type(BoundaryConditionList), public :: parabolicBCs
logical, public :: prescribed_bcs_enabled =.true.
type(MappedScalar3D), public :: solution
type(MappedVector3D), public :: solutionGradient
type(MappedScalar3D), public :: source
real(kind=prec), public :: t
logical, public :: tecplot_enabled =.true.
procedure(SELF_timeIntegrator), public, pointer:: timeIntegrator=> Euler_timeIntegrator
type(MappedTwoPointVector3D), public :: twoPointFlux
real(kind=prec), public :: u
real(kind=prec), public :: v
real(kind=prec), public :: w
type(MappedScalar3D), public :: workSol

Type-Bound Procedures

procedure, public :: AdditionalFree => AdditionalFree_Model

  • public subroutine AdditionalFree_Model(this)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this

procedure, public :: AdditionalInit => AdditionalInit_ECAdvection3D

procedure, public :: AdditionalOutput => AdditionalOutput_Model

  • public subroutine AdditionalOutput_Model(this, fileid)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    integer(kind=HID_T), intent(in) :: fileid

procedure, public :: BoundaryFlux => BoundaryFlux_ECAdvection3D

procedure, public :: CalculateEntropy => CalculateEntropy_DGModel3D_t

procedure, public :: CalculateSolutionGradient => CalculateSolutionGradient_DGModel3D_t

procedure, public :: CalculateTendency => CalculateTendency_ECDGModel3D_t

procedure, public :: Euler_timeIntegrator

  • public subroutine Euler_timeIntegrator(this, tn)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    real(kind=prec), intent(in) :: tn

procedure, public :: FluxMethod => fluxmethod_DGModel3D_t

procedure, public :: ForwardStep => ForwardStep_Model

  • public subroutine ForwardStep_Model(this, tn, dt, ioInterval)

    Forward steps the model using the associated tendency procedure and time integrator

    Read more…

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    real(kind=prec), intent(in) :: tn
    real(kind=prec), intent(in) :: dt
    real(kind=prec), intent(in) :: ioInterval

procedure, public :: Free => Free_ECAdvection3D

  • public subroutine Free_ECAdvection3D(this)

    Free EC Advection 3D, including GPU BC arrays.

    Arguments

    TypeIntentOptionalAttributesName
    class(ECAdvection3D), intent(inout) :: this

procedure, public :: GetSimulationTime

  • public subroutine GetSimulationTime(this, t)

    Returns the current simulation time stored in the model % t attribute

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(in) :: this
    real(kind=prec), intent(out) :: t

procedure, public :: IncrementIOCounter

  • public subroutine IncrementIOCounter(this)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this

procedure, public :: Init => Init_ECAdvection3D

  • public subroutine Init_ECAdvection3D(this, mesh, geometry)

    Initialize EC Advection 3D, then upload BC element/side arrays to GPU.

    Arguments

    TypeIntentOptionalAttributesName
    class(ECAdvection3D), intent(out) :: this
    type(Mesh3D), intent(in), target:: mesh
    type(SEMHex), intent(in), target:: geometry

procedure, public :: LowStorageRK2_timeIntegrator

  • public subroutine LowStorageRK2_timeIntegrator(this, tn)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    real(kind=prec), intent(in) :: tn

procedure, public :: LowStorageRK3_timeIntegrator

  • public subroutine LowStorageRK3_timeIntegrator(this, tn)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    real(kind=prec), intent(in) :: tn

procedure, public :: LowStorageRK4_timeIntegrator

  • public subroutine LowStorageRK4_timeIntegrator(this, tn)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    real(kind=prec), intent(in) :: tn

procedure, public :: MapBoundaryConditions => MapBoundaryConditions_DGModel3D_t

  • public subroutine MapBoundaryConditions_DGModel3D_t(this)

    Scan the mesh sideInfo and populate the elements/sides arrays for each registered boundary condition.

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel3D_t), intent(inout) :: this

procedure, public :: PreTendency => PreTendency_Model

  • public subroutine PreTendency_Model(this)

    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

    Read more…

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this

procedure, public :: PrintType => PrintType_Model

  • public subroutine PrintType_Model(this)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(in) :: this

procedure, public :: ReadModel => Read_DGModel3D_t

  • public subroutine Read_DGModel3D_t(this, fileName)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel3D_t), intent(inout) :: this
    character, intent(in) :: fileName

procedure, public :: ReportEntropy => ReportEntropy_Model

  • public subroutine ReportEntropy_Model(this)

    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.

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(in) :: this

procedure, public :: ReportMetrics => ReportMetrics_DGModel3D_t

  • public subroutine ReportMetrics_DGModel3D_t(this)

    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.

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel3D_t), intent(inout) :: this

procedure, public :: ReportUserMetrics => ReportUserMetrics_Model

  • public subroutine ReportUserMetrics_Model(this)

    Method that can be overridden by users to report their own custom metrics after file io

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this

procedure, public :: SetBoundaryCondition => setboundarycondition_DGModel3D_t

procedure, public :: SetGradientBoundaryCondition => setgradientboundarycondition_DGModel3D_t

procedure, public :: SetMetadata => SetMetadata_DGModel3D_t

procedure, public :: SetNumberOfVariables => SetNumberOfVariables_Model

procedure, public :: SetSimulationTime

  • public subroutine SetSimulationTime(this, t)

    Sets the model % t attribute with the provided simulation time

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    real(kind=prec), intent(in) :: t

generic, public :: SetSolution => SetSolutionFromChar_DGModel3D_t, SetSolutionFromEqn_DGModel3D_t

generic, public :: SetTimeIntegrator => SetTimeIntegrator_withChar

  • public subroutine SetTimeIntegrator_withChar(this, integrator)

    Sets the time integrator method, using a character input

    Read more…

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(inout) :: this
    character, intent(in) :: integrator

procedure, public :: SourceMethod => SourceMethod_ECAdvection3D

  • public subroutine SourceMethod_ECAdvection3D(this)

    No source term — upload the zero-initialised host array to device.

    Arguments

    TypeIntentOptionalAttributesName
    class(ECAdvection3D), intent(inout) :: this

procedure, public :: TwoPointFluxMethod => TwoPointFluxMethod_ECAdvection3D

procedure, public :: UpdateGRK2 => UpdateGRK2_DGModel3D_t

procedure, public :: UpdateGRK3 => UpdateGRK3_DGModel3D_t

procedure, public :: UpdateGRK4 => UpdateGRK4_DGModel3D_t

procedure, public :: UpdateSolution => UpdateSolution_DGModel3D_t

  • public subroutine UpdateSolution_DGModel3D_t(this, dt)

    Computes a solution update as , where dt is either provided through the interface or taken as the Model's stored time step size (model % dt)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel3D_t), intent(inout) :: this
    real(kind=prec), intent(in), optional :: dt

procedure, public :: WriteModel => Write_DGModel3D_t

  • public subroutine Write_DGModel3D_t(this, fileName)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel3D_t), intent(inout) :: this
    character, intent(in), optional :: fileName

procedure, public :: WriteTecplot => WriteTecplot_DGModel3D_t

  • public subroutine WriteTecplot_DGModel3D_t(this, filename)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel3D_t), intent(inout) :: this
    character, intent(in), optional :: filename

procedure, public :: entropy_func => entropy_func_ECAdvection3D_t

  • public pure function entropy_func_ECAdvection3D_t(this, s) result(e)

    Quadratic entropy: eta(u) = u^2 / 2

    Arguments

    TypeIntentOptionalAttributesName
    class(ECAdvection3D_t), intent(in) :: this
    real(kind=prec), intent(in) :: s(1:this%nvar)

    Return Value real(kind=prec)

procedure, public :: flux1D => flux1d_Model

  • public pure function flux1d_Model(this, s, dsdx) result(flux)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(in) :: this
    real(kind=prec), intent(in) :: s(1:this%nvar)
    real(kind=prec), intent(in) :: dsdx(1:this%nvar)

    Return Value real(kind=prec)(1:this%nvar)

procedure, public :: flux2D => flux2d_Model

  • public pure function flux2d_Model(this, s, dsdx) result(flux)

    Arguments

    TypeIntentOptionalAttributesName
    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)

    Return Value real(kind=prec)(1:this%nvar,1:2)

procedure, public :: flux3D => flux3d_Model

  • public pure function flux3d_Model(this, s, dsdx) result(flux)

    Arguments

    TypeIntentOptionalAttributesName
    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)

    Return Value real(kind=prec)(1:this%nvar,1:3)

procedure, public :: riemannflux1d => riemannflux1d_Model

  • public pure function riemannflux1d_Model(this, sL, sR, dsdx, nhat) result(flux)

    Arguments

    TypeIntentOptionalAttributesName
    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

    Return Value real(kind=prec)(1:this%nvar)

procedure, public :: riemannflux2d => riemannflux2d_Model

  • public pure function riemannflux2d_Model(this, sL, sR, dsdx, nhat) result(flux)

    Arguments

    TypeIntentOptionalAttributesName
    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)

    Return Value real(kind=prec)(1:this%nvar)

procedure, public :: riemannflux3d => riemannflux3d_ECAdvection3D_t

  • public pure function riemannflux3d_ECAdvection3D_t(this, sL, sR, dsdx, nhat) result(flux)

    Local Lax-Friedrichs (Rusanov) Riemann flux for linear advection. lambda_max = sqrt(u^2 + v^2 + w^2).

    Arguments

    TypeIntentOptionalAttributesName
    class(ECAdvection3D_t), 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)

    Return Value real(kind=prec)(1:this%nvar)

procedure, public :: source1d => source1d_Model

  • public pure function source1d_Model(this, s, dsdx) result(source)

    Arguments

    TypeIntentOptionalAttributesName
    class(Model), intent(in) :: this
    real(kind=prec), intent(in) :: s(1:this%nvar)
    real(kind=prec), intent(in) :: dsdx(1:this%nvar)

    Return Value real(kind=prec)(1:this%nvar)

procedure, public :: source2d => source2d_Model

  • public pure function source2d_Model(this, s, dsdx) result(source)

    Arguments

    TypeIntentOptionalAttributesName
    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)

    Return Value real(kind=prec)(1:this%nvar)

procedure, public :: source3d => source3d_Model

  • public pure function source3d_Model(this, s, dsdx) result(source)

    Arguments

    TypeIntentOptionalAttributesName
    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)

    Return Value real(kind=prec)(1:this%nvar)

procedure, public :: twopointflux3d => twopointflux3d_ECAdvection3D_t

  • public pure function twopointflux3d_ECAdvection3D_t(this, sL, sR) result(flux)

    Arithmetic-mean two-point flux for linear advection. Entropy-conserving with respect to eta(u) = u^2/2.

    Arguments

    TypeIntentOptionalAttributesName
    class(ECAdvection3D_t), intent(in) :: this
    real(kind=prec), intent(in) :: sL(1:this%nvar)
    real(kind=prec), intent(in) :: sR(1:this%nvar)

    Return Value real(kind=prec)(1:this%nvar,1:3)

Source Code

  type,extends(ECAdvection3D_t),public :: ECAdvection3D

  contains

    procedure :: Init => Init_ECAdvection3D
    procedure :: Free => Free_ECAdvection3D
    procedure :: AdditionalInit => AdditionalInit_ECAdvection3D
    procedure :: BoundaryFlux => BoundaryFlux_ECAdvection3D
    procedure :: TwoPointFluxMethod => TwoPointFluxMethod_ECAdvection3D
    procedure :: SourceMethod => SourceMethod_ECAdvection3D

  endtype ECAdvection3D