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

Create a 3D Domain in the shape of a sphere consisting of six wedges and a central cube. For an image showing how the wedges are aligned in this Domain, see the documentation for Shell. More...

#include <Sphere.hpp>

Classes

struct  InitialGridPoints
 
struct  InitialRefinement
 
struct  InnerRadius
 
struct  OuterRadius
 
struct  UseEquiangularMap
 

Public Types

using options = tmpl::list< InnerRadius, OuterRadius, InitialRefinement, InitialGridPoints, UseEquiangularMap >
 
- Public Types inherited from DomainCreator< 3, TargetFrame >
using creatable_classes = typename DomainCreators_detail::domain_creators< VolumeDim >::template creators< TargetFrame >
 

Public Member Functions

 Sphere (typename InnerRadius::type inner_radius, typename OuterRadius::type outer_radius, typename InitialRefinement::type initial_refinement, typename InitialGridPoints::type initial_number_of_grid_points, typename UseEquiangularMap::type use_equiangular_map) noexcept
 
 Sphere (const Sphere &)=delete
 
 Sphere (Sphere &&) noexcept=default
 
Sphereoperator= (const Sphere &)=delete
 
Sphereoperator= (Sphere &&) noexcept=default
 
Domain< 3, TargetFrame > create_domain () const noexcept override
 
std::vector< std::array< size_t, 3 > > initial_extents () const noexcept override
 Obtain the initial grid extents of the block with the given index.
 
std::vector< std::array< size_t, 3 > > initial_refinement_levels () const noexcept override
 Obtain the initial refinement levels of the blocks.
 
- Public Member Functions inherited from DomainCreator< 3, 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
 

Detailed Description

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

Create a 3D Domain in the shape of a sphere consisting of six wedges and a central cube. For an image showing how the wedges are aligned in this Domain, see the documentation for Shell.

Member Data Documentation

◆ help

template<typename TargetFrame >
constexpr OptionString domain::creators::Sphere< TargetFrame >::help
static
Initial value:
{
"Creates a 3D Sphere with seven Blocks.\n"
"Only one refinement level for all dimensions is currently supported.\n"
"The number of gridpoints in the radial direction can be set\n"
"independently of the number of gridpoints in the angular directions.\n"
"The number of gridpoints along the dimensions of the cube is equal\n"
"to the number of gridpoints along the angular dimensions of the "
"wedges.\n"
"Equiangular coordinates give better gridpoint spacings in the angular\n"
"directions, while equidistant coordinates give better gridpoint\n"
"spacings in the center block."}

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