SphereAMRRegion< dim, number > Class Template Reference

Developer Documentation: MeltPoolDG::AMR::SphereAMRRegion< dim, number > Class Template Reference
Developer Documentation
MeltPoolDG::AMR::SphereAMRRegion< dim, number > Class Template Reference

Represents a spherical region for adaptive mesh refinement. More...

#include <amr_regions.hpp>

Public Member Functions

 SphereAMRRegion (const dealii::Point< dim, number > &center, const number radius)
 Construct a spherical AMR region.
 
bool point_inside (const dealii::Point< dim, number > &p) const
 Check whether a point lies inside the sphere.
 

Private Attributes

const dealii::Point< dim, number > center
 
const number radius
 

Detailed Description

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

Represents a spherical region for adaptive mesh refinement.

Constructor & Destructor Documentation

◆ SphereAMRRegion()

template<int dim, typename number >
MeltPoolDG::AMR::SphereAMRRegion< dim, number >::SphereAMRRegion ( const dealii::Point< dim, number > &  center,
const number  radius 
)
inline

Construct a spherical AMR region.

Parameters
centerThe center of the sphere.
radiusThe radius of the sphere.
Exceptions
dealii::ExcMessageif radius <= 0.

Member Function Documentation

◆ point_inside()

template<int dim, typename number >
bool MeltPoolDG::AMR::SphereAMRRegion< dim, number >::point_inside ( const dealii::Point< dim, number > &  p) const
inline

Check whether a point lies inside the sphere.

Parameters
pThe point to test.
Returns
true if the point is inside the sphere (including the surface), false otherwise.

Member Data Documentation

◆ center

template<int dim, typename number >
const dealii::Point<dim, number> MeltPoolDG::AMR::SphereAMRRegion< dim, number >::center
private

◆ radius

template<int dim, typename number >
const number MeltPoolDG::AMR::SphereAMRRegion< dim, number >::radius
private

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