SpECTRE  v2024.04.12
domain::creators::Rectangle Class Reference

Create a 2D Domain consisting of a single Block. More...

#include <Rectangle.hpp>

Classes

struct  BoundaryCondition
 
struct  InitialGridPoints
 
struct  InitialRefinement
 
struct  IsPeriodicIn
 
struct  LowerBound
 
struct  TimeDependence
 
struct  UpperBound
 

Public Types

using maps_list = tmpl::list< domain::CoordinateMap< Frame::BlockLogical, Frame::Inertial, CoordinateMaps::ProductOf2Maps< CoordinateMaps::Affine, CoordinateMaps::Affine > > >
 
using common_options = tmpl::list< LowerBound, UpperBound, InitialRefinement, InitialGridPoints >
 
using options_periodic = tmpl::list< IsPeriodicIn >
 
template<typename Metavariables >
using options = tmpl::append< common_options, tmpl::conditional_t< domain::BoundaryConditions::has_boundary_conditions_base_v< typename Metavariables::system >, tmpl::list< BoundaryCondition< domain::BoundaryConditions::get_boundary_conditions_base< typename Metavariables::system > > >, options_periodic >, tmpl::list< TimeDependence > >
 

Public Member Functions

 Rectangle (std::array< double, 2 > lower_xy, std::array< double, 2 > upper_xy, std::array< size_t, 2 > initial_refinement_level_xy, std::array< size_t, 2 > initial_number_of_grid_points_in_xy, std::array< bool, 2 > is_periodic_in_xy, std::unique_ptr< domain::creators::time_dependence::TimeDependence< 2 > > time_dependence=nullptr)
 
 Rectangle (std::array< double, 2 > lower_xy, std::array< double, 2 > upper_xy, std::array< size_t, 2 > initial_refinement_level_xy, std::array< size_t, 2 > initial_number_of_grid_points_in_xy, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > boundary_condition, std::unique_ptr< domain::creators::time_dependence::TimeDependence< 2 > > time_dependence, const Options::Context &context={})
 
 Rectangle (const Rectangle &)=delete
 
 Rectangle (Rectangle &&)=default
 
Rectangleoperator= (const Rectangle &)=delete
 
Rectangleoperator= (Rectangle &&)=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. More...
 
std::vector< std::array< size_t, 2 > > initial_extents () const override
 Obtain the initial grid extents of the Elements in each block. More...
 
std::vector< std::array< size_t, 2 > > initial_refinement_levels () const override
 Obtain the initial refinement levels of the blocks. More...
 
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. More...
 
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). More...
 
- Public Member Functions inherited from DomainCreator< 2 >
 DomainCreator (const DomainCreator< VolumeDim > &)=delete
 
 DomainCreator (DomainCreator< VolumeDim > &&)=default
 
DomainCreator< VolumeDim > & operator= (const DomainCreator< VolumeDim > &)=delete
 
DomainCreator< VolumeDim > & operator= (DomainCreator< VolumeDim > &&)=default
 
virtual Domain< VolumeDim > create_domain () const=0
 
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::vector< DirectionMap< VolumeDim, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > > > external_boundary_conditions () const=0
 The set of external boundary condition for every block in the domain. More...
 
virtual std::vector< std::stringblock_names () const
 A human-readable name for every block, or empty if the domain creator doesn't support block names (yet). More...
 
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 std::vector< std::array< size_t, VolumeDim > > initial_extents () const=0
 Obtain the initial grid extents of the Elements in each block. More...
 
virtual std::vector< std::array< size_t, VolumeDim > > initial_refinement_levels () const=0
 Obtain the initial refinement levels of the blocks. More...
 
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. More...
 

Static Public Attributes

static constexpr Options::String help {"Creates a 2D rectangle."}
 
- Static Public Attributes inherited from DomainCreator< 2 >
static constexpr size_t volume_dim
 

Detailed Description

Create a 2D Domain consisting of a single Block.

Member Function Documentation

◆ block_names()

std::vector< std::string > domain::creators::Rectangle::block_names ( ) const
inlineoverridevirtual

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::Rectangle::create_domain ( ) const
overridevirtual

Implements DomainCreator< 2 >.

◆ external_boundary_conditions()

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

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

Implements DomainCreator< 2 >.

◆ functions_of_time()

auto domain::creators::Rectangle::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< 2 >.

◆ initial_extents()

std::vector< std::array< size_t, 2 > > domain::creators::Rectangle::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::Rectangle::initial_refinement_levels ( ) const
overridevirtual

Obtain the initial refinement levels of the blocks.

Implements DomainCreator< 2 >.


The documentation for this class was generated from the following file: