MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number > Class Template Reference

Represents a spherical shell region for adaptive mesh refinement (AMR). More...

#include <amr_regions.hpp>

Public Member Functions
	SphericalShellAMRRegion ()=default
	Default constructor (required for boost serialization). Sets all members to 0.
	SphericalShellAMRRegion (const dealii::Point< dim, number > &center, const number inner_radius, const number outer_radius)
	Construct a spherical shell AMR region.
bool	point_inside (const dealii::Point< dim, number > &p) const
	Check whether a point lies inside the spherical shell.
template<class Archive >
void	serialize (Archive &ar, const unsigned int)
	Serialize or deserialize the object's data members.

Private Attributes
dealii::Point< dim, number >	center = dealii::Point<dim, number>()
number	inner_radius = 0.
number	outer_radius = 0.

Detailed Description

template<int dim, typename number>
class MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >

Represents a spherical shell region for adaptive mesh refinement (AMR).

Constructor & Destructor Documentation

SphericalShellAMRRegion() [1/2]

template<int dim, typename number >

MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >::SphericalShellAMRRegion ( )

default

Default constructor (required for boost serialization). Sets all members to 0.

Note

This constructor is not meant to be used by the user as it leaves the object in a state where the main function of the class point_inside() cannot be used in a meaningful way.

SphericalShellAMRRegion() [2/2]

template<int dim, typename number >

MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >::SphericalShellAMRRegion ( const dealii::Point< dim, number > &  center, const number  inner_radius, const number  outer_radius  )

inline

Construct a spherical shell AMR region.

Parameters

center	The center of the shell.
inner_radius	The inner radius of the shell.
outer_radius	The outer radius of the shell.

Exceptions

dealii::ExcMessage

if inner_radius < 0 or inner_radius > outer_radius.

Member Function Documentation

point_inside()

template<int dim, typename number >

bool MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >::point_inside ( const dealii::Point< dim, number > &  p ) const

inline

Check whether a point lies inside the spherical shell.

Parameters

p	The point to test.

Returns

true if the point is inside the shell (including the surface), false otherwise.

serialize()

template<int dim, typename number >

template<class Archive >

void MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >::serialize ( Archive &  ar, const unsigned int    )

inline

Serialize or deserialize the object's data members.

Parameters

ar	Reference to the archive object used for serialization/deserialization.
version	Version number of the class (unused).

Member Data Documentation

center

template<int dim, typename number >

dealii::Point<dim, number> MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >::center = dealii::Point<dim, number>()

private

inner_radius

template<int dim, typename number >

number MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >::inner_radius = 0.

private

outer_radius

template<int dim, typename number >

number MeltPoolDG::AMR::SphericalShellAMRRegion< dim, number >::outer_radius = 0.

private

---

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

• include/meltpooldg/utilities/amr_regions.hpp