SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
domain::creators::CartoonSphere1D Class Reference

Create a 3D Domain that is topologically a line. The 2nd and 3rd dimensions use Cartoon bases with Killing vectors along the \(\theta\) and \(\phi\) directions. More...

#include <CartoonSphere1D.hpp>

Classes

struct  InitialNumberOfRadialGridPoints
struct  InitialRadialRefinement
struct  InnerBoundaryCondition
struct  InnerRadius
struct  OuterBoundaryCondition
struct  OuterRadius
struct  RadialDistributions
struct  RadialPartitioning
struct  TimeDependence

Public Types

using maps_list
using basic_options
template<typename Metavariables>
using options

Public Member Functions

 CartoonSphere1D (double inner_bound, double outer_bound, typename InitialRadialRefinement::type &&initial_refinement_levels, typename InitialNumberOfRadialGridPoints::type &&initial_num_points, std::vector< double > radial_partitioning={}, const typename RadialDistributions::type &radial_distributions=domain::CoordinateMaps::Distribution::Linear, std::unique_ptr< domain::creators::time_dependence::TimeDependence< 3 > > time_dependence=nullptr, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > inner_boundary_condition=nullptr, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > outer_boundary_condition=nullptr, const Options::Context &context={})
 CartoonSphere1D (const CartoonSphere1D &)=delete
 CartoonSphere1D (CartoonSphere1D &&)=default
CartoonSphere1Doperator= (const CartoonSphere1D &)=delete
CartoonSphere1Doperator= (CartoonSphere1D &&)=default
Domain< 3 > create_domain () const override
std::vector< DirectionMap< 3, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > > > external_boundary_conditions () const override
 The set of external boundary condition for every block in the domain.
std::vector< std::array< size_t, 3 > > initial_extents () const override
 Obtain the initial grid extents of the Elements in each block.
std::vector< std::array< size_t, 3 > > initial_refinement_levels () const override
 Obtain the initial refinement levels of the blocks.
std::vector< std::stringblock_names () const override
 A human-readable name for every block, or empty if the domain creator doesn't support block names (yet).
std::unordered_map< std::string, std::unordered_set< std::string > > block_groups () const override
 Labels to refer to groups of blocks. The groups can overlap, and they don't have to cover all blocks in the domain. The groups can be used to refer to multiple blocks at once when specifying input-file options.
auto functions_of_time (const std::unordered_map< std::string, double > &initial_expiration_times={}) const -> std::unordered_map< std::string, std::unique_ptr< domain::FunctionsOfTime::FunctionOfTime > > override
 Retrieve the functions of time used for moving meshes.
Public Member Functions inherited from DomainCreator< 3 >
DomainCreator< VolumeDim > & operator= (const DomainCreator< VolumeDim > &)=delete
virtual std::unordered_map< std::string, tnsr::I< double, VolumeDim, Frame::Grid > > grid_anchors () const
 A set of named coordinates in the grid frame, like the center of the domain or the positions of specific objects in a domain.

Static Public Member Functions

static std::string name ()

Static Public Attributes

static constexpr Options::String help
Static Public Attributes inherited from DomainCreator< 3 >
static constexpr size_t volume_dim

Detailed Description

Create a 3D Domain that is topologically a line. The 2nd and 3rd dimensions use Cartoon bases with Killing vectors along the \(\theta\) and \(\phi\) directions.

Member Typedef Documentation

◆ basic_options

using domain::creators::CartoonSphere1D::basic_options
Initial value:
Radius of the cylinder's outer edge.
Definition AngularCylinder.hpp:66
Radial coordinates of the boundaries splitting elements.
Definition AngularCylinder.hpp:101
Time dependence of the domain.
Definition AngularCylinder.hpp:182
Definition CartoonSphere1D.hpp:51

◆ maps_list

using domain::creators::CartoonSphere1D::maps_list
Initial value:
A coordinate map or composition of coordinate maps.
Definition CoordinateMap.hpp:314
Identity map from .
Definition Identity.hpp:28
Maps in the 1D interval to in the interval according to a domain::CoordinateMaps::Distribution.
Definition Interval.hpp:82
Product of three one-dimensional CoordinateMaps.
Definition ProductMaps.hpp:92
Definition IndexType.hpp:42
Definition IndexType.hpp:46

◆ options

template<typename Metavariables>
using domain::creators::CartoonSphere1D::options
Initial value:
tmpl::conditional_t<
domain::BoundaryConditions::has_boundary_conditions_base_v<
typename Metavariables::system>,
tmpl::push_back<
basic_options,
typename Metavariables::system>>,
typename Metavariables::system>>>,
basic_options>
typename detail::get_boundary_conditions_base< T >::type get_boundary_conditions_base
Returns T::boundary_condition_base or a placeholder class.
Definition GetBoundaryConditionsBase.hpp:32

Member Function Documentation

◆ block_groups()

std::unordered_map< std::string, std::unordered_set< std::string > > domain::creators::CartoonSphere1D::block_groups ( ) const
overridevirtual

Labels to refer to groups of blocks. The groups can overlap, and they don't have to cover all blocks in the domain. The groups can be used to refer to multiple blocks at once when specifying input-file options.

Reimplemented from DomainCreator< 3 >.

◆ block_names()

std::vector< std::string > domain::creators::CartoonSphere1D::block_names ( ) const
overridevirtual

A human-readable name for every block, or empty if the domain creator doesn't support block names (yet).

Reimplemented from DomainCreator< 3 >.

◆ create_domain()

Domain< 3 > domain::creators::CartoonSphere1D::create_domain ( ) const
overridevirtual

Implements DomainCreator< 3 >.

◆ external_boundary_conditions()

std::vector< DirectionMap< 3, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > > > domain::creators::CartoonSphere1D::external_boundary_conditions ( ) const
overridevirtual

The set of external boundary condition for every block in the domain.

Implements DomainCreator< 3 >.

◆ functions_of_time()

auto domain::creators::CartoonSphere1D::functions_of_time ( const std::unordered_map< std::string, double > & initial_expiration_times = {}) const -> std::unordered_map< std::string, std::unique_ptr<domain::FunctionsOfTime::FunctionOfTime>>
overridevirtual

Retrieve the functions of time used for moving meshes.

Reimplemented from DomainCreator< 3 >.

◆ initial_extents()

std::vector< std::array< size_t, 3 > > domain::creators::CartoonSphere1D::initial_extents ( ) const
overridevirtual

Obtain the initial grid extents of the Elements in each block.

Implements DomainCreator< 3 >.

◆ initial_refinement_levels()

std::vector< std::array< size_t, 3 > > domain::creators::CartoonSphere1D::initial_refinement_levels ( ) const
overridevirtual

Obtain the initial refinement levels of the blocks.

Implements DomainCreator< 3 >.

Member Data Documentation

◆ help

Options::String domain::creators::CartoonSphere1D::help
staticconstexpr
Initial value:
{
"A sphere domain that requires/enforces spherical symmetry, resulting in "
"a 1D computational domain (the radial axis). It uses Cartoon partial "
"derivatives for the angular directions not in the computational "
"domain."}

The documentation for this class was generated from the following file:
  • src/Domain/Creators/CartoonSphere1D.hpp