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

Create a 2D Domain consisting of four rotated Blocks. More...

#include <RotatedRectangles.hpp>

Classes

struct  BoundaryCondition
struct  InitialGridPoints
struct  InitialRefinement
struct  IsPeriodicIn
struct  LowerBound
struct  Midpoint
struct  UpperBound

Public Types

using maps_list
using common_options
using options_periodic = tmpl::list<IsPeriodicIn>
template<typename Metavariables>
using options

Public Member Functions

 RotatedRectangles (typename LowerBound::type lower_xy, typename Midpoint::type midpoint_xy, typename UpperBound::type upper_xy, typename InitialRefinement::type initial_refinement_level_xy, typename InitialGridPoints::type initial_number_of_grid_points_in_xy, typename IsPeriodicIn::type is_periodic_in)
 RotatedRectangles (typename LowerBound::type lower_xy, typename Midpoint::type midpoint_xy, typename UpperBound::type upper_xy, typename InitialRefinement::type initial_refinement_level_xy, typename InitialGridPoints::type initial_number_of_grid_points_in_xy, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > boundary_condition, const Options::Context &context={})
 RotatedRectangles (const RotatedRectangles &)=delete
 RotatedRectangles (RotatedRectangles &&)=default
RotatedRectanglesoperator= (const RotatedRectangles &)=delete
RotatedRectanglesoperator= (RotatedRectangles &&)=default
Domain< 2 > create_domain () const override
std::vector< DirectionMap< 2, 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::stringblock_names () const override
 A human-readable name for every block, or empty if the domain creator doesn't support block names (yet).
std::vector< std::array< size_t, 2 > > initial_extents () const override
 Obtain the initial grid extents of the Elements in each block.
std::vector< std::array< size_t, 2 > > initial_refinement_levels () const override
 Obtain the initial refinement levels of the blocks.
Public Member Functions inherited from DomainCreator< 2 >
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.
virtual std::unordered_map< std::string, std::unordered_set< std::string > > block_groups () const
 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.
virtual 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 > >
 Retrieve the functions of time used for moving meshes.

Static Public Attributes

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

Detailed Description

Create a 2D Domain consisting of four rotated Blocks.

  • The lower left block has its logical \(\xi\)-axis aligned with the grid x-axis.
  • The lower right block is rotated a half-turn (180 degrees) relative to the lower left block.
  • The upper left block is rotated a quarter-turn counterclockwise (+90 degrees) relative to the lower left block.
  • The upper right block is rotated a quarter-turn clockwise (-90 degrees) relative to the lower left block.

This DomainCreator is useful for testing code that deals with unaligned blocks.

Member Typedef Documentation

◆ common_options

using domain::creators::RotatedRectangles::common_options
Initial value:

◆ maps_list

using domain::creators::RotatedRectangles::maps_list
Initial value:
A coordinate map or composition of coordinate maps.
Definition CoordinateMap.hpp:314
Affine map from .
Definition Affine.hpp:37
A CoordinateMap that swaps/negates the coordinate axes.
Definition DiscreteRotation.hpp:32
Product of two codimension=0 CoordinateMaps.
Definition ProductMaps.hpp:35
Definition IndexType.hpp:42
Definition IndexType.hpp:46

◆ options

template<typename Metavariables>
using domain::creators::RotatedRectangles::options
Initial value:
tmpl::append<
common_options,
tmpl::conditional_t<
domain::BoundaryConditions::has_boundary_conditions_base_v<
typename Metavariables::system>,
tmpl::list<BoundaryCondition<
typename Metavariables::system>>>,
options_periodic>>
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
Boundary condition to impose on outer side.
Definition AngularDisk.hpp:102

Member Function Documentation

◆ block_names()

std::vector< std::string > domain::creators::RotatedRectangles::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< 2 >.

◆ create_domain()

Domain< 2 > domain::creators::RotatedRectangles::create_domain ( ) const
overridevirtual

Implements DomainCreator< 2 >.

◆ external_boundary_conditions()

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

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

Implements DomainCreator< 2 >.

◆ initial_extents()

std::vector< std::array< size_t, 2 > > domain::creators::RotatedRectangles::initial_extents ( ) const
overridevirtual

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

Implements DomainCreator< 2 >.

◆ initial_refinement_levels()

std::vector< std::array< size_t, 2 > > domain::creators::RotatedRectangles::initial_refinement_levels ( ) const
overridevirtual

Obtain the initial refinement levels of the blocks.

Implements DomainCreator< 2 >.

Member Data Documentation

◆ help

Options::String domain::creators::RotatedRectangles::help
staticconstexpr
Initial value:
= {
"A DomainCreator useful for testing purposes.\n"
"RotatedRectangles uses four rotated Blocks to create the rectangle\n"
"[LowerX,UpperX] x [LowerY,UpperY]. The outermost index to\n"
"InitialGridPoints is the dimension index, and the innermost index is\n"
"the block index along that dimension."}

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