Procedures

Register boundary conditions for the advection-diffusion model. Hyperbolic: mirror (no-normal-flow) wall condition on the solution. Parabolic: no-stress condition that zeros the normal gradient at the boundary, giving zero diffusive flux through walls. This is stable with the Bassi-Rebay (BR1) method.

Register boundary conditions for the advection-diffusion model. Hyperbolic: mirror (no-normal-flow) wall condition on the solution. Parabolic: no-stress condition that zeros the normal gradient at the boundary, giving zero diffusive flux through walls. This is stable with the Bassi-Rebay (BR1) method.

\addtogroup SELF_SupportRoutines @{ \fn AlmostEqual Compares two floating point numbers and determines if they are equal (to machine precision).

LLF Riemann flux on GPU — fully device-resident.

LLF Riemann flux on GPU — fully device-resident.

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.

GPU implementation of the EC-DG 2-D tendency.

Computes du/dt = source - EC-DG flux divergence.

\addtogroup SELF_SupportRoutines @{ \fn CompareArray Compares to INTEGER arrays and determines if they are identical.

GPU implementation of the reference-element split-form divergence. df must be a device pointer to a scalar field of size (N+1)(N+1)nElem*nVar.

Computes the split-form (two-point) divergence of a 2-D vector field in the reference element (computational coordinates).

GPU implementation of the reference-element split-form divergence. df must be a device pointer to a scalar field of size (N+1)^3 * nElem * nVar.

Computes the split-form (two-point) divergence of a 3-D vector field in the reference element (computational coordinates).

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

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

The entropy function is the sum of kinetic and internal energy For the linear model, this is

The entropy function is the sum of kinetic and internal energy For the linear model, this is

\addtogroup SELF_SupportRoutines @{ \fn ForwardShift Shift an array integers by one index forward, moving the last index to the first.

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

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

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

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

Free EC Advection 2D, including GPU BC arrays.

Free EC Advection 3D, including GPU BC arrays.

Frees all memory (host and device) associated with an instance of the Lagrange class

Frees all memory (host and device) associated with an instance of the Lagrange class

Frees all memory (host and device) associated with an instance of the Lagrange_t class

Returns the node associated with the given bcid. If the bcid is not found, a null pointer is returned.

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

GPU-accelerated mirror BC for 2D EC Advection.

Mirror boundary condition on the solution: sets the exterior state equal to the interior state. With LLF this zeroes the upwind dissipation at the wall.

Mirror boundary condition: sets extBoundary = interior state. With the LLF Riemann flux, this gives sR = sL at the boundary, so the Riemann flux reduces to the central flux (a.n)*s — no dissipation. Use this BC when testing entropy conservation.

No-normal-flow boundary condition for 2D linear Euler equations. Reflects the velocity vector about the boundary normal while preserving density and pressure.

GPU-accelerated no-normal-flow BC for 2D Linear Euler.

No-normal-flow boundary condition for 2D linear shallow water equations. Reflects the velocity vector about the boundary normal while preserving the free surface elevation.

GPU-accelerated radiation BC for 2D Linear Euler.

GPU-accelerated mirror BC for 3D EC Advection.

Mirror boundary condition on the solution: sets the exterior state equal to the interior state. With LLF this zeroes the upwind dissipation at the wall.

Mirror boundary condition: sets extBoundary = interior state.

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

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

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

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

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

Initialize an instance of the Lagrange class On output, all of the attributes for the Lagrange class are allocated and values are initialized according to the number of control points, number of target points, and the types for the control and target nodes. If a GPU is available, device pointers for the Lagrange attributes are allocated and initialized.

Initialize an instance of the Lagrange class On output, all of the attributes for the Lagrange class are allocated and values are initialized according to the number of control points, number of target points, and the types for the control and target nodes. If a GPU is available, device pointers for the Lagrange attributes are allocated and initialized.

Initialize an instance of the Lagrange_t class On output, all of the attributes for the Lagrange_t class are allocated and values are initialized according to the number of control points, number of target points, and the types for the control and target nodes. If a GPU is available, device pointers for the Lagrange_t attributes are allocated and initialized.

Allocate the interior array for a 2-D two-point vector field. The interior array has rank 6 with layout (n,i,j,nEl,nVar,idir).

Allocate the interior array for a 3-D two-point vector field. The interior array has rank 7 with layout (n,i,j,k,nEl,nVar,idir).

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

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

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

Computes the divergence of a 2-D vector using the weak form On input, the attribute of the vector is assigned and the attribute is set to the physical directions of the vector. This method will project the vector onto the contravariant basis vectors.

Computes the divergence of a 3-D vector using the weak form On input, the attribute of the vector is assigned and the attribute is set to the physical directions of the vector. This method will project the vector onto the contravariant basis vectors.

Computes the divergence of a 3-D vector using the weak form On input, the attribute of the vector is assigned and the attribute is set to the physical directions of the vector. This method will project the vector onto the contravariant basis vectors.

Calculates the gradient of a function using the weak form of the gradient and the average boundary state. This method will compute the average boundary state from the and attributes of

Calculates the gradient of a function using the weak form of the gradient and the average boundary state. This method will compute the average boundary state from the and attributes of

GPU implementation of the physical-space split-form divergence for a 2-D two-point vector on a curvilinear mesh.

Computes the physical-space divergence of a 2-D split-form vector field on a curvilinear mesh.

GPU implementation of the physical-space split-form divergence for a 3-D two-point vector on a curvilinear mesh.

Computes the physical-space divergence of a 3-D split-form vector field on a curvilinear mesh.

Calculates the gradient of a function using the strong form of the gradient in mapped coordinates.

Calculates the gradient of a function using the strong form of the gradient in mapped coordinates.

Calculates the gradient of a function using the strong form of the gradient in mapped coordinates.

Calculates the gradient of a function using the strong form of the gradient in mapped coordinates.

No-stress boundary condition for the BR1 diffusive flux. Reflects the interior gradient so that the normal component of the averaged gradient vanishes at the boundary: sigma_ext = sigma_int - 2 (sigma_int . nhat) nhat This gives zero diffusive flux through the wall and is unconditionally stable for Bassi-Rebay.

No-stress boundary condition for the BR1 diffusive flux. Reflects the interior gradient so that the normal component of the averaged gradient vanishes at the boundary: sigma_ext = sigma_int - 2 (sigma_int . nhat) nhat This gives zero diffusive flux through the wall and is unconditionally stable for Bassi-Rebay.

Populate the elements and sides arrays for a registered boundary condition. Called after scanning the mesh to determine which faces belong to each bcid.

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

Register a boundary condition function with the given bcid and bcname. If the bcid is already registered, the function pointer is updated. The elements and sides arrays are not allocated here; call PopulateBoundaries after scanning the mesh.

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.

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.

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.

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

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

This method can be used to reset all of the boundary elements boundary condition type to the desired value.

This method can be used to reset all of the boundary elements boundary condition type to the desired value.

This method can be used to reset all of the boundary elements boundary condition type to the desired value.

Local Lax-Friedrichs (Rusanov) Riemann flux for linear advection. Entropy-stable: provides symmetric dissipation at element interfaces. lambda_max = sqrt(u^2 + v^2) is the maximum wave speed.

Uses a local lax-friedrich's upwind flux The max eigenvalue is taken as the sound speed

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

Uses a local lax-friedrich's upwind flux The max eigenvalue is taken as the sound speed

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.

Apply boundary conditions for the solution. Periodic boundaries are set as the default; registered boundary conditions overwrite specific endpoints.

Apply registered boundary conditions for the solution. Each boundary condition method loops over its own boundary faces.

Apply registered boundary conditions for the solution.

Set the description of the ivar-th variable

Sets the equation parser for the ivar-th variable

Sets the equation parser for the idir direction and ivar-th variable

Sets the equation parser for the idir direction and ivar-th variable

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.

Apply boundary conditions for the solution gradient. Periodic boundaries are set as the default; registered boundary conditions overwrite specific endpoints.

Apply registered boundary conditions for the solution gradient. Each boundary condition method loops over its own boundary faces.

Apply registered boundary conditions for the solution gradient.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Sets the this % interior attribute using the eqn attribute, geometry (for physical positions), and provided simulation time.

Set the name of the ivar-th variable

Sets the model % t attribute with the provided simulation time

Sets the time integrator method, using a character input

Set the units of the ivar-th variable

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

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

This subroutine sets the initial condition for a weak blast wave problem. The initial condition is given by

This subroutine sets the initial condition for a weak blast wave problem. The initial condition is given by

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

Entropy-conserving two-point flux function.

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

Entropy-conserving two-point flux function (3-D). flux(ivar, d) is the d-th physical component (d=1:x, d=2:y, d=3:z). Override in concrete models. Stub returns zero.

Contravariant EC two-point flux on GPU — fully device-resident.

Contravariant EC two-point flux on GPU — fully device-resident.

Computes pre-projected SCALAR contravariant two-point fluxes for all node pairs and stores them in twoPointFlux%interior(n,i,j,iel,ivar,r).

Computes pre-projected SCALAR contravariant two-point fluxes for all node pairs, following Trixi.jl for curved meshes. Each direction r uses the correct partner AND the correct averaged metric Ja^r.

\addtogroup SELF_SupportRoutines @{ \fn UniformPoints Generates a REAL(prec) array of N points evenly spaced between two points.

Create a structured mesh and store it in SELF's unstructured mesh format. The mesh is created in tiles of size (tnx,tny). Tiling is used to determine the element ordering.

Create a structured mesh and store it in SELF's unstructured mesh format. The mesh is created in tiles of size (tnx,tny,tnz). Tiling is used to determine the element ordering.

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)

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)

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)

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)

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)

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)

Writes the metadata to a HDF5 file using the fields : * /metadata/{group}/name/{varid} * /metadata/{group}/description/{varid} * /metadata/{group}/units/{varid}