Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
domain::creators::Rectangle< TargetFrame > Class Template Reference

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

#include <Rectangle.hpp>

Classes

struct  InitialGridPoints
 
struct  InitialRefinement
 
struct  IsPeriodicIn
 
struct  LowerBound
 
struct  UpperBound
 

Public Types

using options = tmpl::list< LowerBound, UpperBound, IsPeriodicIn, InitialRefinement, InitialGridPoints >
 
- Public Types inherited from DomainCreator< 2, TargetFrame >
using creatable_classes = typename DomainCreators_detail::domain_creators< VolumeDim >::template creators< TargetFrame >
 

Public Member Functions

 Rectangle (typename LowerBound::type lower_xy, typename UpperBound::type upper_xy, typename IsPeriodicIn::type is_periodic_in_xy, typename InitialRefinement::type initial_refinement_level_xy, typename InitialGridPoints::type initial_number_of_grid_points_in_xy, const OptionContext &context={}) noexcept
 
 Rectangle (const Rectangle &)=delete
 
 Rectangle (Rectangle &&) noexcept=default
 
Rectangleoperator= (const Rectangle &)=delete
 
Rectangleoperator= (Rectangle &&) noexcept=default
 
Domain< 2, TargetFrame > create_domain () const noexcept override
 
std::vector< std::array< size_t, 2 > > initial_extents () const noexcept override
 Obtain the initial grid extents of the block with the given index.
 
std::vector< std::array< size_t, 2 > > initial_refinement_levels () const noexcept override
 Obtain the initial refinement levels of the blocks.
 
- Public Member Functions inherited from DomainCreator< 2, TargetFrame >
 DomainCreator (const DomainCreator< VolumeDim, TargetFrame > &)=delete
 
 DomainCreator (DomainCreator< VolumeDim, TargetFrame > &&) noexcept=default
 
DomainCreator< VolumeDim, TargetFrame > & operator= (const DomainCreator< VolumeDim, TargetFrame > &)=delete
 
DomainCreator< VolumeDim, TargetFrame > & operator= (DomainCreator< VolumeDim, TargetFrame > &&) noexcept=default
 

Static Public Attributes

static constexpr OptionString help {"Creates a 2D rectangle."}
 

Detailed Description

template<typename TargetFrame>
class domain::creators::Rectangle< TargetFrame >

Create a 2D Domain consisting of a single Block.


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