3D grid class in one domain. More...

#include <grilles.h>

Public Member Functions
	Grille3d (int n_r, int n_t, int n_p, int typer, int typet, int typep, int baser)
	Constructor. More...

	Grille3d (const Grille3d &)
	Copy constructor. More...

void	operator= (const Grille3d &)
	Assignement operator. More...

virtual	~Grille3d ()
	Destructor. More...

int	get_nr () const
	Returns `nr`. More...

int	get_nt () const
	Returns `nt`. More...

int	get_np () const
	Returns `np`. More...

int	get_type_r () const
	Returns `type_r`. More...

int	get_type_t () const
	Returns `type_t`. More...

int	get_type_p () const
	Returns `type_p`. More...

int	get_base_r () const
	Returns `base_r`. More...

Public Attributes
double *	x
	Array of values of $\xi$ at the `nr` collocation points. More...

double *	tet
	Array of values of $\theta$ at the `nt` collocation points. More...

double *	phi
	Array of values of $\phi$ at the `np` collocation points. More...

Protected Member Functions
void	compute_radial_grid ()
	Computes the collocation point coordinates in the radial direction. More...

Protected Attributes
const int	nr
	Number of points in r ( $\xi$ ) More...

const int	nt
	Number of points in $\theta$ . More...

const int	np
	Number of points in $\phi$ . More...

int	type_r
	Type of sampling in r ( $\xi$ ) (`RARE`,`FIN`,`UNSURR` ) More...

int	type_t
	Type of sampling in $\theta$ (`SYM`,`NONSYM`) More...

int	type_p
	Type of sampling in $\phi$ (`SYM`,`NONSYM`) More...

int	base_r
	Type of radial spectral basis (`BASE_CHEB`, `BASE_LEG`, BASE_JAC02 ) More...

Detailed Description

3D grid class in one domain.

()

Basic 3D spherical grid class in spherical coordinates $(r,\theta,\phi)$ . The radial coordinate $\xi$ lies in the range [0, 1] or [-1, 1] depending upon the sampling (RARE or FIN ). Its relation with the physical radial coordinate r is defined by the mapping (cf. class Map) and is described in Bonazzola, Gourgoulhon & Marck, Phys. Rev. D 58, 104020 (1998). Note: this monogrid should not be used. Use instead Mg3d.

Version: #$Id: grilles.h,v 1.25 2023/05/24 09:48:50 g_servignat Exp $#

Definition at line 200 of file grilles.h.

Constructor & Destructor Documentation

◆ Grille3d() [1/2]

Lorene::Grille3d::Grille3d	(	int	n_r,
		int	n_t,
		int	n_p,
		int	typer,
		int	typet,
		int	typep,
		int	baser
	)

Constructor.

Definition at line 125 of file grille3d.C.

References compute_radial_grid(), nr, nt, tet, type_t, and x.

◆ Grille3d() [2/2]

Lorene::Grille3d::Grille3d ( const Grille3d & )

Copy constructor.

◆ ~Grille3d()

Lorene::Grille3d::~Grille3d ( )

virtual

Destructor.

Definition at line 169 of file grille3d.C.

References phi, tet, and x.

Member Function Documentation

◆ compute_radial_grid()

void Lorene::Grille3d::compute_radial_grid ( )

protected

Computes the collocation point coordinates in the radial direction.

Definition at line 175 of file grille3d.C.

References base_r, and nr.

◆ get_base_r()

int Lorene::Grille3d::get_base_r ( ) const

inline

Returns base_r.

Definition at line 249 of file grilles.h.

References base_r.

◆ get_np()

int Lorene::Grille3d::get_np ( ) const

inline

Returns np.

Definition at line 240 of file grilles.h.

References np.

◆ get_nr()

int Lorene::Grille3d::get_nr ( ) const

inline

Returns nr.

Definition at line 236 of file grilles.h.

References nr.

◆ get_nt()

int Lorene::Grille3d::get_nt ( ) const

inline

Returns nt.

Definition at line 238 of file grilles.h.

References nt.

◆ get_type_p()

int Lorene::Grille3d::get_type_p ( ) const

inline

Returns type_p.

Definition at line 247 of file grilles.h.

References type_p.

◆ get_type_r()

int Lorene::Grille3d::get_type_r ( ) const

inline

Returns type_r.

Definition at line 243 of file grilles.h.

References type_r.

◆ get_type_t()

int Lorene::Grille3d::get_type_t ( ) const

inline

Returns type_t.

Definition at line 245 of file grilles.h.

References type_t.

◆ operator=()

void Lorene::Grille3d::operator= ( const Grille3d & )

Assignement operator.

Member Data Documentation

◆ base_r

int Lorene::Grille3d::base_r

protected

Type of radial spectral basis (BASE_CHEB, BASE_LEG, BASE_JAC02 )

Definition at line 211 of file grilles.h.

◆ np

const int Lorene::Grille3d::np

protected

Number of points in $\phi$ .

Definition at line 204 of file grilles.h.

◆ nr

const int Lorene::Grille3d::nr

protected

Number of points in r ( $\xi$ )

Definition at line 202 of file grilles.h.

◆ nt

const int Lorene::Grille3d::nt

protected

Number of points in $\theta$ .

Definition at line 203 of file grilles.h.

◆ phi

double* Lorene::Grille3d::phi

Array of values of $\phi$ at the np collocation points.

Definition at line 219 of file grilles.h.

◆ tet

double* Lorene::Grille3d::tet

Array of values of $\theta$ at the nt collocation points.

Definition at line 217 of file grilles.h.

◆ type_p

int Lorene::Grille3d::type_p

protected

Type of sampling in $\phi$ (SYM,NONSYM)

Definition at line 209 of file grilles.h.

◆ type_r

int Lorene::Grille3d::type_r

protected

Type of sampling in r ( $\xi$ ) (RARE,FIN,UNSURR )

Definition at line 207 of file grilles.h.

◆ type_t

int Lorene::Grille3d::type_t

protected

Type of sampling in $\theta$ (SYM,NONSYM)

Definition at line 208 of file grilles.h.

◆ x

double* Lorene::Grille3d::x

Array of values of $\xi$ at the nr collocation points.

Definition at line 215 of file grilles.h.

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Grille3d() [1/2]

◆ Grille3d() [2/2]

◆ ~Grille3d()

Member Function Documentation

◆ compute_radial_grid()

◆ get_base_r()

◆ get_np()

◆ get_nr()

◆ get_nt()

◆ get_type_p()

◆ get_type_r()

◆ get_type_t()

◆ operator=()

Member Data Documentation

◆ base_r

◆ np

◆ nr

◆ nt

◆ phi

◆ tet

◆ type_p

◆ type_r

◆ type_t

◆ x