qugar::impl::funcs::EllipsoidBase< dim > Class Template Reference

Dimension independent ellipsoidal function (base cass). The function is defined by the ellipsoid's semi-axes and centered at the origin. The function presents a negative sign around the origin, and positive far away. More...

#include <primitive_funcs_lib.hpp>

Inheritance diagram for qugar::impl::funcs::EllipsoidBase< dim >:

Public Member Functions
	EllipsoidBase (const Point< dim > &semi_axes, const RefSystem< dim > &system)
	Constructs an Ellipsoid object with specified semi-axes and reference system.
const Point< dim > &	semi_axes () const
	Gets the semi-axes of the ellipsoid.
const RefSystem< dim > &	ref_system () const
	Gets the reference system of the ellipsoid.

Static Protected Member Functions
static RefSystem< dim >	get_default_system ()
	Gets the default reference system of the ellipsoid.

Protected Attributes
Point< dim >	semi_axes_
	Ellipsoid's semi-axes.
RefSystem< dim >	system_
	Ellipsoid's reference system.

Detailed Description

template<int dim>
class qugar::impl::funcs::EllipsoidBase< dim >

Dimension independent ellipsoidal function (base cass). The function is defined by the ellipsoid's semi-axes and centered at the origin. The function presents a negative sign around the origin, and positive far away.

Note

This class is implemented as an orthotropic scaling of a sphere.

Template Parameters

dim	Parametric dimension.

Constructor & Destructor Documentation

EllipsoidBase()

template<int dim>

qugar::impl::funcs::EllipsoidBase< dim >::EllipsoidBase	(	const Point< dim > &	semi_axes,
		const RefSystem< dim > &	system )

Constructs an Ellipsoid object with specified semi-axes and reference system.

Parameters

semi_axes	A Point object representing the semi-axes of the ellipsoid.
system	A RefSystem object representing the reference system in which the ellipsoid is defined.

Member Function Documentation

get_default_system()

template<int dim>

static RefSystem< dim > qugar::impl::funcs::EllipsoidBase< dim >::get_default_system ( )

staticnodiscardprotected

Gets the default reference system of the ellipsoid.

Returns

Default (Cartesian) coordinate system.

ref_system()

template<int dim>

const RefSystem< dim > & qugar::impl::funcs::EllipsoidBase< dim >::ref_system ( ) const

nodiscard

Gets the reference system of the ellipsoid.

Returns

real The ellipsoid's reference system.

semi_axes()

template<int dim>

const Point< dim > & qugar::impl::funcs::EllipsoidBase< dim >::semi_axes ( ) const

nodiscard

Gets the semi-axes of the ellipsoid.

Returns

real The ellipsoid's semi-axes.

Member Data Documentation

semi_axes_

template<int dim>

Point<dim> qugar::impl::funcs::EllipsoidBase< dim >::semi_axes_

protected

Ellipsoid's semi-axes.

system_

template<int dim>

RefSystem<dim> qugar::impl::funcs::EllipsoidBase< dim >::system_

protected

Ellipsoid's reference system.

---

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

• /__w/qugar/qugar/cpp/include/qugar/primitive_funcs_lib.hpp