SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
evolution::dg::Initialization::Domain< Metavariables, UseControlSystems > Struct Template Reference

Initialize items related to the basic structure of the element. More...

#include <DgDomain.hpp>

Public Types

using const_global_cache_tags = tmpl::list<::domain::Tags::Domain<dim>>
 Tags for constant items added to the GlobalCache. These items are initialized from input file options.
using mutable_global_cache_tags
 Tags for mutable items added to the GlobalCache. These items are initialized from input file options.
using simple_tags_from_options
 Tags for simple DataBox items that are initialized from input file options.
using default_initialized_simple_tags = tmpl::list<>
 Tags for simple DataBox items that are default initialized.
using argument_tags
 Tags for items fetched by the DataBox and passed to the apply function.
using return_tags
 Tags for items in the DataBox that are mutated by the apply function.
using simple_tags
 Tags for mutable DataBox items that are either default initialized or initialized by the apply function.
using compute_tags
 Tags for immutable DataBox items (compute items or reference items) added to the DataBox.

Static Public Member Functions

static void apply (const gsl::not_null< Mesh< dim > * > mesh, const gsl::not_null< Element< dim > * > element, const gsl::not_null< ElementMap< dim, Frame::Grid > * > element_map, const gsl::not_null< std::unique_ptr< ::domain::CoordinateMapBase< Frame::Grid, Frame::Inertial, dim > > * > grid_to_inertial_map, const gsl::not_null< DirectionalIdMap< dim, Mesh< dim > > * > neighbor_mesh, const ::Domain< dim > &domain, const std::vector< std::array< size_t, dim > > &initial_extents, const std::vector< std::array< size_t, dim > > &initial_refinement, const Spectral::Quadrature &i1_quadrature, const ElementId< dim > &element_id)
 Given the items fetched from a DataBox by the argument_tags, mutate the items in the DataBox corresponding to return_tags.

Static Public Attributes

static constexpr size_t dim = Metavariables::volume_dim

Detailed Description

template<typename Metavariables, bool UseControlSystems = false>
struct evolution::dg::Initialization::Domain< Metavariables, UseControlSystems >

Initialize items related to the basic structure of the element.

Details

See the type aliases defined below for what items are added to the GlobalCache and DataBox and how they are initialized

Member Typedef Documentation

◆ argument_tags

template<typename Metavariables, bool UseControlSystems = false>
using evolution::dg::Initialization::Domain< Metavariables, UseControlSystems >::argument_tags
Initial value:
tmpl::append<const_global_cache_tags, simple_tags_from_options,
tmpl::list<::Parallel::Tags::ArrayIndex<ElementId<dim>>>>

Tags for items fetched by the DataBox and passed to the apply function.

◆ compute_tags

template<typename Metavariables, bool UseControlSystems = false>
using evolution::dg::Initialization::Domain< Metavariables, UseControlSystems >::compute_tags
Initial value:
tmpl::list<
tmpl::conditional_t<UseControlSystems,
Metavariables>,
Definition IndexType.hpp:43
Definition IndexType.hpp:45
Definition IndexType.hpp:46
Tag used to retrieve data from the Parallel::GlobalCache. This is the recommended way for compute tag...
Definition GlobalCache.hpp:1019
The FunctionsOfTime initialized from a DomainCreator, initial time, and control system OptionHolders.
Definition FunctionsOfTimeInitialize.hpp:49
The coordinate map from source to target coordinates.
Definition Tags.hpp:30
Computes the Inertial coordinates, the inverse Jacobian from the Grid to the Inertial frame,...
Definition TagsTimeDependent.hpp:58
The coordinates in a given frame.
Definition Tags.hpp:85
Computes the determinant of the inverse Jacobian.
Definition Tags.hpp:202
The coordinate map from the ElementLogical frame to the TargetFrame.
Definition Tags.hpp:70
Computes the Logical to Inertial inverse Jacobian from CoordinatesVelocityAndJacobians
Definition TagsTimeDependent.hpp:140
The FunctionsOfTime initialized from a DomainCreator.
Definition FunctionsOfTime.hpp:24
Computes the Inertial coordinates from CoordinatesVelocityAndJacobians
Definition TagsTimeDependent.hpp:93
Computes the Inertial mesh velocity from CoordinatesVelocityAndJacobians
Definition TagsTimeDependent.hpp:178
Computes the inverse Jacobian of the map held by MapTag at the coordinates held by SourceCoordsTag....
Definition Tags.hpp:135
The logical coordinates in the Element.
Definition LogicalCoordinates.hpp:90
The coordinates in the target frame of MapTag. The SourceCoordsTag's frame must be the source frame o...
Definition Tags.hpp:98
Definition MinimumGridSpacing.hpp:42
The divergence of the frame velocity.
Definition TagsDomain.hpp:27

Tags for immutable DataBox items (compute items or reference items) added to the DataBox.

◆ mutable_global_cache_tags

template<typename Metavariables, bool UseControlSystems = false>
using evolution::dg::Initialization::Domain< Metavariables, UseControlSystems >::mutable_global_cache_tags
Initial value:

Tags for mutable items added to the GlobalCache. These items are initialized from input file options.

◆ return_tags

template<typename Metavariables, bool UseControlSystems = false>
using evolution::dg::Initialization::Domain< Metavariables, UseControlSystems >::return_tags
Initial value:
tmpl::list<::domain::Tags::Mesh<dim>, ::domain::Tags::Element<dim>,
The Element associated with the DataBox.
Definition Tags.hpp:52
Holds the mesh of each neighboring element, oriented to the host's logical frame.
Definition NeighborMesh.hpp:29

Tags for items in the DataBox that are mutated by the apply function.

◆ simple_tags

template<typename Metavariables, bool UseControlSystems = false>
using evolution::dg::Initialization::Domain< Metavariables, UseControlSystems >::simple_tags
Initial value:
tmpl::append<default_initialized_simple_tags, return_tags>

Tags for mutable DataBox items that are either default initialized or initialized by the apply function.

◆ simple_tags_from_options

template<typename Metavariables, bool UseControlSystems = false>
using evolution::dg::Initialization::Domain< Metavariables, UseControlSystems >::simple_tags_from_options
Initial value:
tmpl::list<::domain::Tags::InitialExtents<dim>,
The initial refinement level per dimension for all elements in each block of the initial computationa...
Definition InitialRefinementLevels.hpp:23
The quadrature points to use initially.
Definition QuadratureTag.hpp:29

Tags for simple DataBox items that are initialized from input file options.


The documentation for this struct was generated from the following file:
  • src/Evolution/Initialization/DgDomain.hpp