A spherical compression about some center, as given by domain::CoordinateMaps::TimeDependent::SphericalCompression<false>. More...

#include <SphericalCompression.hpp>

Classes
struct	Center
	Center for the SphericalCompression map. More...

struct	InitialAcceleration
	Initial radial acceleration for the function of time for the spherical compression. More...

struct	InitialTime
	The initial time of the function of time. More...

struct	InitialValue
	Initial value for function of time for the spherical compression. More...

struct	InitialVelocity
	Initial radial velocity for the function of time for the spherical compression. More...

struct	MaxRadius
	Maximum radius for the SphericalCompression map. More...

struct	MinRadius
	Minimum radius for the SphericalCompression map. More...

Public Types
using	maps_list = tmpl::list< domain::CoordinateMap< Frame::Grid, Frame::Inertial, SphericalCompressionMap > >

using	GridToInertialMap = detail::generate_coordinate_map_t< Frame::Grid, Frame::Inertial, tmpl::list< SphericalCompressionMap > >

using	options = tmpl::list< InitialTime, MinRadius, MaxRadius, Center, InitialValue, InitialVelocity, InitialAcceleration >

Public Types inherited from domain::creators::time_dependence::TimeDependence< 3 >
using	creatable_classes = tmpl::append< creatable_classes_any_dim, tmpl::conditional_t< MeshDim==1, creatable_classes_1d, tmpl::conditional_t< MeshDim==2, creatable_classes_2d, creatable_classes_3d > > >

Public Member Functions
	SphericalCompression (const SphericalCompression &)=delete

	SphericalCompression (SphericalCompression &&)=default

SphericalCompression &	operator= (const SphericalCompression &)=delete

SphericalCompression &	operator= (SphericalCompression &&)=default

	SphericalCompression (double initial_time, double min_radius, double max_radius, std::array< double, 3 > center, double initial_value, double initial_velocity, double initial_acceleration, const Options::Context &context={})

auto	get_clone () const -> std::unique_ptr< TimeDependence< mesh_dim > > override
	Returns a `std::unique_ptr` pointing to a copy of the `TimeDependence`. More...

auto	block_maps_grid_to_inertial (size_t number_of_blocks) const -> std::vector< std::unique_ptr< domain::CoordinateMapBase< Frame::Grid, Frame::Inertial, mesh_dim > > > override
	Returns the coordinate maps from the `Frame::Grid` to the `Frame::Inertial` frame for each block. More...

auto	block_maps_grid_to_distorted (size_t number_of_blocks) const -> std::vector< std::unique_ptr< domain::CoordinateMapBase< Frame::Grid, Frame::Distorted, mesh_dim > > > override
	Returns the coordinate maps from the `Frame::Grid` to the `Frame::Distorted` frame for each block. Returns vector of nullptr if there is no distorted frame. More...

auto	block_maps_distorted_to_inertial (size_t number_of_blocks) const -> std::vector< std::unique_ptr< domain::CoordinateMapBase< Frame::Distorted, Frame::Inertial, mesh_dim > > > override
	Returns the coordinate maps from the `Frame::Distorted` to the `Frame::Inertial` frame for each block. Returns vector of nullptr if is no distorted frame. 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
	Returns the functions of time for the domain. More...

Public Member Functions inherited from domain::creators::time_dependence::TimeDependence< 3 >
	TimeDependence (const TimeDependence &)=default

	TimeDependence (TimeDependence &&)=default

TimeDependence &	operator= (const TimeDependence &)=default

TimeDependence &	operator= (TimeDependence &&)=default

virtual auto	get_clone () const -> std::unique_ptr< TimeDependence >=0
	Returns a `std::unique_ptr` pointing to a copy of the `TimeDependence`. More...

virtual auto	block_maps_grid_to_inertial (size_t number_of_blocks) const -> std::vector< std::unique_ptr< domain::CoordinateMapBase< Frame::Grid, Frame::Inertial, MeshDim > > >=0
	Returns the coordinate maps from the `Frame::Grid` to the `Frame::Inertial` frame for each block. More...

virtual auto	block_maps_grid_to_distorted (size_t number_of_blocks) const -> std::vector< std::unique_ptr< domain::CoordinateMapBase< Frame::Grid, Frame::Distorted, MeshDim > > >=0
	Returns the coordinate maps from the `Frame::Grid` to the `Frame::Distorted` frame for each block. Returns vector of nullptr if there is no distorted frame. More...

virtual auto	block_maps_distorted_to_inertial (size_t number_of_blocks) const -> std::vector< std::unique_ptr< domain::CoordinateMapBase< Frame::Distorted, Frame::Inertial, MeshDim > > >=0
	Returns the coordinate maps from the `Frame::Distorted` to the `Frame::Inertial` frame for each block. Returns vector of nullptr if is no distorted frame. 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 > >=0
	Returns the functions of time for the domain. More...

bool	is_none () const
	Returns `true` if the instance is `None`, meaning no time dependence.

Static Public Attributes
static constexpr size_t	mesh_dim = 3

static constexpr Options::String	help = {"A spherical compression."}

Friends
bool	operator== (const SphericalCompression &lhs, const SphericalCompression &rhs)

Detailed Description

A spherical compression about some center, as given by domain::CoordinateMaps::TimeDependent::SphericalCompression<false>.

Details

This TimeDependence is suitable for use on a spherical shell, where MinRadius and MaxRadius are the inner and outer radii of the shell, respectively.

Note: The quantity stored in the FunctionOfTime is really the spherical-harmonic coefficient \(\lambda_{00}(t)\). This is different from the Shape map, which stores ylm::Spherepack coefficients \(a_{lm}(t)\) and \(b_{lm}(t)\) instead of \(\lambda_{lm}(t)\). See domain::CoordinateMaps::TimeDependent::Shape for more details.

Member Function Documentation

◆ block_maps_distorted_to_inertial()

auto domain::creators::time_dependence::SphericalCompression::block_maps_distorted_to_inertial ( size_t number_of_blocks ) const -> std::vector<std::unique_ptr<domain::CoordinateMapBase< Frame::Distorted, Frame::Inertial, mesh_dim>>>

inlineoverridevirtual

Returns the coordinate maps from the Frame::Distorted to the Frame::Inertial frame for each block. Returns vector of nullptr if is no distorted frame.

Implements domain::creators::time_dependence::TimeDependence< 3 >.

◆ block_maps_grid_to_distorted()

auto domain::creators::time_dependence::SphericalCompression::block_maps_grid_to_distorted ( size_t number_of_blocks ) const -> std::vector<std::unique_ptr<domain::CoordinateMapBase< Frame::Grid, Frame::Distorted, mesh_dim>>>

inlineoverridevirtual

Returns the coordinate maps from the Frame::Grid to the Frame::Distorted frame for each block. Returns vector of nullptr if there is no distorted frame.

Implements domain::creators::time_dependence::TimeDependence< 3 >.

◆ block_maps_grid_to_inertial()

auto domain::creators::time_dependence::SphericalCompression::block_maps_grid_to_inertial ( size_t number_of_blocks ) const -> std::vector<std::unique_ptr<domain::CoordinateMapBase< Frame::Grid, Frame::Inertial, mesh_dim>>>

overridevirtual

Returns the coordinate maps from the Frame::Grid to the Frame::Inertial frame for each block.

Implements domain::creators::time_dependence::TimeDependence< 3 >.

◆ functions_of_time()

auto domain::creators::time_dependence::SphericalCompression::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

Returns the functions of time for the domain.

Implements domain::creators::time_dependence::TimeDependence< 3 >.

◆ get_clone()

auto domain::creators::time_dependence::SphericalCompression::get_clone ( ) const -> std::unique_ptr<TimeDependence<mesh_dim>>

overridevirtual

Returns a std::unique_ptr pointing to a copy of the TimeDependence.

Implements domain::creators::time_dependence::TimeDependence< 3 >.

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

src/Domain/Creators/TimeDependence/SphericalCompression.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Details

Member Function Documentation

◆ block_maps_distorted_to_inertial()

◆ block_maps_grid_to_distorted()

◆ block_maps_grid_to_inertial()

◆ functions_of_time()

◆ get_clone()