Burgers1D_t Derived Type

  1. SELF_Burgers1D_t.f90
  2. self_Burgers1D_t
  3. Burgers1D_t

type, public, extends(DGModel1D) :: Burgers1D_t


Inherits

type~~burgers1d_t~~InheritsGraph type~burgers1d_t Burgers1D_t type~dgmodel1d DGModel1D type~burgers1d_t->type~dgmodel1d type~dgmodel1d_t DGModel1D_t type~dgmodel1d->type~dgmodel1d_t type~model Model type~dgmodel1d_t->type~model type~mappedscalar1d MappedScalar1D type~dgmodel1d_t->type~mappedscalar1d solution, solutionGradient, flux, source, fluxDivergence, dSdt, workSol type~mesh1d Mesh1D type~dgmodel1d_t->type~mesh1d mesh type~boundaryconditionlist BoundaryConditionList type~dgmodel1d_t->type~boundaryconditionlist hyperbolicBCs, parabolicBCs type~geometry1d Geometry1D type~dgmodel1d_t->type~geometry1d geometry type~mappedscalar1d_t MappedScalar1D_t type~mappedscalar1d->type~mappedscalar1d_t type~semmesh SEMMesh type~mesh1d->type~semmesh type~boundarycondition BoundaryCondition type~boundaryconditionlist->type~boundarycondition current, head, tail type~scalar1d Scalar1D type~geometry1d->type~scalar1d x, dxds type~mappedscalar1d_t->type~geometry1d geometry type~mappedscalar1d_t->type~scalar1d type~domaindecomposition DomainDecomposition type~semmesh->type~domaindecomposition decomp c_ptr c_ptr type~scalar1d->c_ptr blas_handle, interior_gpu, boundary_gpu, extBoundary_gpu, avgBoundary_gpu, boundarynormal_gpu type~scalar1d_t Scalar1D_t type~scalar1d->type~scalar1d_t type~boundarycondition->type~boundarycondition next, prev type~boundarycondition->c_ptr elements_gpu, sides_gpu type~domaindecomposition->c_ptr elemToRank_gpu type~domaindecomposition_t DomainDecomposition_t type~domaindecomposition->type~domaindecomposition_t type~self_dataobj SELF_DataObj type~scalar1d_t->type~self_dataobj type~lagrange Lagrange type~self_dataobj->type~lagrange interp EquationParser EquationParser type~self_dataobj->EquationParser eqn type~metadata Metadata type~self_dataobj->type~metadata meta type~lagrange->c_ptr qWeights_gpu, iMatrix_gpu, dMatrix_gpu, dgMatrix_gpu, dSplitMatrix_gpu, bMatrix_gpu type~lagrange_t Lagrange_t type~lagrange->type~lagrange_t type~lagrange_t->c_ptr blas_handle

Inherited by

type~~burgers1d_t~~InheritedByGraph type~burgers1d_t Burgers1D_t type~burgers1d Burgers1D type~burgers1d->type~burgers1d_t type~burgers1d~2 Burgers1D type~burgers1d~2->type~burgers1d_t

Contents

Variables

Type-Bound Procedures

Source Code

Burgers1D_t

Components

TypeVisibilityAttributesNameInitial
type(MappedScalar1D), public :: dSdt
real(kind=prec), public :: dt
real(kind=prec), public :: entropy
type(MappedScalar1D), public :: flux
type(MappedScalar1D), public :: fluxDivergence
type(Geometry1D), public, pointer:: geometry
logical, public :: gradient_enabled =.false.
type(BoundaryConditionList), public :: hyperbolicBCs
integer, public :: ioIterate =0
type(Mesh1D), public, pointer:: mesh
real(kind=prec), public :: nu =0.0_prec
integer, public :: nvar
type(BoundaryConditionList), public :: parabolicBCs
logical, public :: prescribed_bcs_enabled =.true.
type(MappedScalar1D), public :: solution
type(MappedScalar1D), public :: solutionGradient
type(MappedScalar1D), public :: source
real(kind=prec), public :: t
logical, public :: tecplot_enabled =.true.
procedure(SELF_timeIntegrator), public, pointer:: timeIntegrator=> Euler_timeIntegrator
type(MappedScalar1D), 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_Model

  • public subroutine AdditionalInit_Model(this)

    Arguments

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

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_DGModel1D

procedure, public :: CalculateEntropy => CalculateEntropy_DGModel1D

procedure, public :: CalculateSolutionGradient => CalculateSolutionGradient_DGModel1D

procedure, public :: CalculateTendency => CalculateTendency_DGModel1D

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_DGModel1D

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_DGModel1D

  • public subroutine Free_DGModel1D(this)

    Free the 1D DG model, including GPU BC arrays.

    Arguments

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

  • public subroutine Init_DGModel1D(this, mesh, geometry)

    Initialize the 1D DG model, then upload BC element/side arrays to GPU.

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel1D), intent(out) :: this
    type(Mesh1D), intent(in), target:: mesh
    type(Geometry1D), 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_DGModel1D_t

  • public subroutine MapBoundaryConditions_DGModel1D_t(this)

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

    Arguments

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

procedure, public :: PostStepHook => PostStepHook_Model

  • public subroutine PostStepHook_Model(this)

    PostStepHook is a template routine invoked by the time integrators once immediately after each completed time step (after this%t has advanced by this%dt). The default implementation is a no-op.

    Read more…

    Arguments

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

procedure, public :: PreStepHook => PreStepHook_Model

  • public subroutine PreStepHook_Model(this)

    PreStepHook is a template routine invoked by the time integrators once immediately before each time step is taken (before any Runge-Kutta stages of that step). The default implementation is a no-op.

    Read more…

    Arguments

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

procedure, public :: PreTendencyHook => PreTendencyHook_Model

  • public subroutine PreTendencyHook_Model(this)

    PreTendencyHook 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 PreTendencyHook 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_DGModel1D_t

  • public subroutine Read_DGModel1D_t(this, fileName)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel1D_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_Model

  • public subroutine ReportMetrics_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 :: 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_DGModel1D

  • public subroutine setboundarycondition_DGModel1D(this)

    Apply boundary conditions for the solution on GPU. Syncs boundary data from device, applies host-side BC dispatch (periodic defaults + registered BCs), then syncs back to device.

    Arguments

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

procedure, public :: SetGradientBoundaryCondition => setgradientboundarycondition_DGModel1D

  • public subroutine setgradientboundarycondition_DGModel1D(this)

    Apply gradient boundary conditions on GPU. Syncs gradient boundary data from device, applies host-side BC dispatch (periodic defaults + registered BCs), then syncs back to device.

    Arguments

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

procedure, public :: SetMetadata => SetMetadata_Burgers1D_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_DGModel1D_t, SetSolutionFromEqn_DGModel1D_t

  • public subroutine SetSolutionFromChar_DGModel1D_t(this, eqnChar)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel1D_t), intent(inout) :: this
    character(len=SELF_EQUATION_LENGTH), intent(in) :: eqnChar(1:this%solution%nVar)

  • public subroutine SetSolutionFromEqn_DGModel1D_t(this, eqn)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel1D_t), intent(inout) :: this
    type(EquationParser), intent(in) :: eqn(1:this%solution%nVar)

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_DGModel1D

procedure, public :: UpdateGRK2 => UpdateGRK2_DGModel1D

  • public subroutine UpdateGRK2_DGModel1D(this, m)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel1D), intent(inout) :: this
    integer, intent(in) :: m

procedure, public :: UpdateGRK3 => UpdateGRK3_DGModel1D

  • public subroutine UpdateGRK3_DGModel1D(this, m)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel1D), intent(inout) :: this
    integer, intent(in) :: m

procedure, public :: UpdateGRK4 => UpdateGRK4_DGModel1D

  • public subroutine UpdateGRK4_DGModel1D(this, m)

    Arguments

    TypeIntentOptionalAttributesName
    class(DGModel1D), intent(inout) :: this
    integer, intent(in) :: m

procedure, public :: UpdateSolution => UpdateSolution_DGModel1D

  • public subroutine UpdateSolution_DGModel1D(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(DGModel1D), intent(inout) :: this
    real(kind=prec), intent(in), optional :: dt

procedure, public :: WriteModel => Write_DGModel1D_t

  • public subroutine Write_DGModel1D_t(this, fileName)

    Arguments

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

procedure, public :: WriteTecplot => WriteTecplot_DGModel1D_t

  • public subroutine WriteTecplot_DGModel1D_t(this, filename)

    Arguments

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

procedure, public :: entropy_func => entropy_func_Burgers1D_t

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

    Arguments

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

    Return Value real(kind=prec)

procedure, public :: flux1d => flux1d_Burgers1D_t

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

    Arguments

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

    Return Value real(kind=prec)(1:this%solution%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_Burgers1D_t

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

    Arguments

    TypeIntentOptionalAttributesName
    class(Burgers1D_t), intent(in) :: this
    real(kind=prec), intent(in) :: sL(1:this%solution%nvar)
    real(kind=prec), intent(in) :: sR(1:this%solution%nvar)
    real(kind=prec), intent(in) :: dsdx(1:this%solution%nvar)
    real(kind=prec), intent(in) :: nhat

    Return Value real(kind=prec)(1:this%solution%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_Model

  • public pure function riemannflux3d_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: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)

Source Code

  type,extends(dgmodel1d) :: Burgers1D_t
    ! Add any additional attributes here that are specific to your model
    real(prec) :: nu = 0.0_prec ! Diffusivity/viscosity

  contains
    procedure :: SetMetadata => SetMetadata_Burgers1D_t
    procedure :: entropy_func => entropy_func_Burgers1D_t
    procedure :: flux1d => flux1d_Burgers1D_t
    procedure :: riemannflux1d => riemannflux1d_Burgers1D_t

  endtype Burgers1D_t