domain::creators::Disk Class Reference

Create a 2D Domain in the shape of a disk from a square surrounded by four wedges. More...

#include <Disk.hpp>

Classes
struct	BoundaryCondition
struct	InitialGridPoints
struct	InitialRefinement
struct	InnerRadius
struct	OuterRadius
struct	UseEquiangularMap

Public Types
using	maps_list
using	basic_options
template<typename Metavariables>
using	options

Public Member Functions
	Disk (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, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > boundary_condition=nullptr, const Options::Context &context={})
	Disk (const Disk &)=delete
	Disk (Disk &&)=default
Disk &	operator= (const Disk &)=delete
Disk &	operator= (Disk &&)=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::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.
std::vector< std::string >	block_names () const override
	A human-readable name for every block, or empty if the domain creator doesn't support block names (yet).
std::unordered_map< std::string, std::unordered_set< std::string > >	block_groups () const override
	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.
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 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 in the shape of a disk from a square surrounded by four wedges.

Member Typedef Documentation

basic_options

using domain::creators::Disk::basic_options

Initial value:

 tmpl::list<InnerRadius, OuterRadius, InitialRefinement,
                                   InitialGridPoints, UseEquiangularMap>

maps_list

using domain::creators::Disk::maps_list

Initial value:

 
      tmpl::list<domain::CoordinateMap<
                     Frame::BlockLogical, Frame::Inertial,
                     CoordinateMaps::ProductOf2Maps<CoordinateMaps::Affine,
                                                    CoordinateMaps::Affine>>,
                 domain::CoordinateMap<Frame::BlockLogical, Frame::Inertial,
                                       CoordinateMaps::ProductOf2Maps<
                                           CoordinateMaps::Equiangular,
                                           CoordinateMaps::Equiangular>>,
                 domain::CoordinateMap<Frame::BlockLogical, Frame::Inertial,
                                       CoordinateMaps::Wedge<2>>>

options

template<typename Metavariables>

using domain::creators::Disk::options

Initial value:

 tmpl::conditional_t<
      domain::BoundaryConditions::has_boundary_conditions_base_v<
          typename Metavariables::system>,
      tmpl::push_back<
          basic_options,
          BoundaryCondition<
              domain::BoundaryConditions::get_boundary_conditions_base<
                  typename Metavariables::system>>>,
      basic_options>

Member Function Documentation

block_groups()

std::unordered_map< std::string, std::unordered_set< std::string > > domain::creators::Disk::block_groups ( ) const

inlineoverridevirtual

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.

Reimplemented from DomainCreator< 2 >.

block_names()

std::vector< std::string > domain::creators::Disk::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::Disk::create_domain ( ) const

overridevirtual

Implements DomainCreator< 2 >.

external_boundary_conditions()

std::vector< DirectionMap< 2, std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > > > domain::creators::Disk::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::Disk::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::Disk::initial_refinement_levels ( ) const

overridevirtual

Obtain the initial refinement levels of the blocks.

Implements DomainCreator< 2 >.

Member Data Documentation

help

Options::String domain::creators::Disk::help

staticconstexpr

Initial value:

{
      "Creates a 2D Disk with five Blocks.\n"
      "Only one refinement level for both dimensions is currently supported.\n"
      "The number of gridpoints in each dimension can be set independently.\n"
      "The number of gridpoints along the dimensions of the square is equal\n"
      "to the number of gridpoints along the angular dimension of the wedges.\n"
      "Equiangular coordinates give better gridpoint spacings in the angular\n"
      "direction, while equidistant coordinates give better gridpoint\n"
      "spacings in the center block."}

---

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

• src/Domain/Creators/Disk.hpp