domain::creators::RotatedBricks Class Reference

Create a 3D Domain consisting of eight rotated Blocks. More...

#include <RotatedBricks.hpp>

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

Public Types
using	maps_list = tmpl::list< domain::CoordinateMap< Frame::Logical, Frame::Inertial, CoordinateMaps::ProductOf3Maps< CoordinateMaps::Affine, CoordinateMaps::Affine, CoordinateMaps::Affine > >, domain::CoordinateMap< Frame::Logical, Frame::Inertial, CoordinateMaps::DiscreteRotation< 3 >, CoordinateMaps::ProductOf3Maps< CoordinateMaps::Affine, CoordinateMaps::Affine, CoordinateMaps::Affine > > >
using	common_options = tmpl::list< LowerBound, Midpoint, 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 > >

Public Member Functions
	RotatedBricks (typename LowerBound::type lower_xyz, typename Midpoint::type midpoint_xyz, typename UpperBound::type upper_xyz, typename InitialRefinement::type initial_refinement_level_xyz, typename InitialGridPoints::type initial_number_of_grid_points_in_xyz, typename IsPeriodicIn::type is_periodic_in) noexcept
	RotatedBricks (typename LowerBound::type lower_xyz, typename Midpoint::type midpoint_xyz, typename UpperBound::type upper_xyz, typename InitialRefinement::type initial_refinement_level_xyz, typename InitialGridPoints::type initial_number_of_grid_points_in_xyz, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > boundary_condition, const Options::Context &context={})
	RotatedBricks (const RotatedBricks &)=delete
	RotatedBricks (RotatedBricks &&) noexcept=default
RotatedBricks &	operator= (const RotatedBricks &)=delete
RotatedBricks &	operator= (RotatedBricks &&) noexcept=default
Domain< 3 >	create_domain () const noexcept override
std::vector< std::array< size_t, 3 > >	initial_extents () const noexcept override
	Obtain the initial grid extents of the Elements in each block. More...
std::vector< std::array< size_t, 3 > >	initial_refinement_levels () const noexcept override
	Obtain the initial refinement levels of the blocks. More...
Public Member Functions inherited from DomainCreator< 3 >
	DomainCreator (const DomainCreator< VolumeDim > &)=delete
	DomainCreator (DomainCreator< VolumeDim > &&) noexcept=default
DomainCreator< VolumeDim > &	operator= (const DomainCreator< VolumeDim > &)=delete
DomainCreator< VolumeDim > &	operator= (DomainCreator< VolumeDim > &&) noexcept=default
virtual auto	functions_of_time () const noexcept -> 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

Detailed Description

Create a 3D Domain consisting of eight rotated Blocks.

The orientations of the blocks are described in two different ways:

• 1 - As orientations of blocks relative to the physical cartesian axes.
• 2 - As rotations relative to the physical cartesian axes written using Rubik's cube rotation notation, for the sake of shorter variable names.

For reference, this is the notation used:

• U - A clockwise 90 degree rotation about the +z axis (The "up" side)
• R - A clockwise 90 degree rotation about the +x axis (The "right" side)
• F - A clockwise 90 degree rotation about the -y axis (The "front" side)

For reference, D, L, and B ("down", "left", and "back") are the inverse rotation to the aforementioned ones, respectively. Note: Whereas Rubik's cube rotations rotate a layer of the 3x3 puzzle cube, we are adopting the notation to apply to rotations of the cube itself.

• The -x, -y, -z block has the aligned orientation, that is, xi is aligned with x, eta is aligned with y, and zeta with z.
• The +x, -y, -z block has the orientation (zeta, eta, -xi). It corresponds to the orientation obtained by the rotation F.
• The -x, +y, -z block has the orientation (xi, zeta, -eta). It corresponds to the orientation obtained by the rotation R.
• The +x, +y, -z block has the orientation (zeta, -xi, -eta). It corresponds to the orientation obtained by the rotation F followed by the rotation R.
• The -x, -y, +z block has the orientation (eta, -xi, zeta). It corresponds to the orientation obtained by the rotation U.
• The +x, -y, +z block has the orientation (eta, -zeta, -xi). It corresponds to the orientation obtained by the rotation F followed by the rotation U.
• The -x, +y, +z block has the orientation (zeta, -xi, -eta). It corresponds to the orientation obtained by the rotation R followed by the rotation U (equivalently, F followed by R).
• The +x, +y, +z block also has the aligned orientation (xi, eta, zeta), relative to the edifice. It is not aligned relative to its neighbors.

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

Member Function Documentation

create_domain()

Domain< 3 > domain::creators::RotatedBricks::create_domain ( ) const

overridevirtualnoexcept

Implements DomainCreator< 3 >.

initial_extents()

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

overridevirtualnoexcept

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::RotatedBricks::initial_refinement_levels ( ) const

overridevirtualnoexcept

Obtain the initial refinement levels of the blocks.

Implements DomainCreator< 3 >.

Member Data Documentation

help

constexpr Options::String domain::creators::RotatedBricks::help

staticconstexpr

Initial value:

= {
      "A DomainCreator useful for testing purposes.\n"
      "RotatedBricks uses eight rotated Blocks to create the rectangular\n"
      "prism [LowerX,UpperX] x [LowerY,UpperY] x [LowerZ,UpperZ]. The\n"
      "outermost index to InitialGridPoints is the dimension index, and\n"
      "the innermost index is the block index along that dimension."}