The Space class is an ensemble of domains describing the whole space of the computation. More...

#include <space.hpp>

Inheritance diagram for Kadath::Space:

Public Member Functions
int	get_ndim () const
	Returns the number of dimensions. More...

int	get_nbr_domains () const
	Returns the number of `Domains`. More...

int	get_type_base () const
	Returns the type of basis. More...

virtual void	save (FILE *) const
	Saving function. More...

const Domain *	get_domain (int i) const
	returns a pointer on the domain. More...

virtual int	nbr_unknowns_from_variable_domains () const
	Gives the number of unknowns coming from the variable shape of the domain. More...

virtual void	affecte_coef_to_variable_domains (int &conte, int cc, Array< int > &doms) const
	The variation of the functions describing the shape of the `Domain` are affected from the unknowns of the system. More...

virtual void	xx_to_ders_variable_domains (const Array< double > &xx, int &conte) const
	Update the vairable domains from a set of values. More...

virtual void	xx_to_vars_variable_domains (System_of_eqs *syst, const Array< double > &xx, int &conte) const
	Update the variables of a system, from the variation of the shape of the domains. More...

virtual Array< int >	get_indices_matching_non_std (int dom, int bound) const
	Gives the number of the other domains, touching a given boundary. More...

Protected Member Functions
	Space ()
	Standard constructor. More...

virtual	~Space ()
	Destructor. More...

Protected Attributes
int	nbr_domains
	Number od `Domains`. More...

int	ndim
	Number of dimensions (should be the same for all the `Domains`). More...

int	type_base
	Type of basis used (i.e. using either Chebyshev or Legendre polynomials). More...

Domain **	domains
	Pointers on the various `Domains`. More...

Friends
ostream &	operator<< (ostream &o, const Space &so)
	Display. More...

Detailed Description

The Space class is an ensemble of domains describing the whole space of the computation.

It is a purely abstract class and so space must be constructed via the derived classes.

Definition at line 1362 of file space.hpp.

Constructor & Destructor Documentation

◆ Space()

Kadath::Space::Space ( )

protected

Standard constructor.

Definition at line 27 of file space.cpp.

◆ ~Space()

Kadath::Space::~Space ( )

protectedvirtual

Destructor.

Definition at line 31 of file space.cpp.

References domains, and nbr_domains.

Member Function Documentation

◆ affecte_coef_to_variable_domains()

virtual void Kadath::Space::affecte_coef_to_variable_domains	(	int &	conte,
		int	cc,
		Array< int > &	doms
	)		const

inlinevirtual

The variation of the functions describing the shape of the Domain are affected from the unknowns of the system.

Parameters

conte	: current position if the unknowns.
cc	: position of the unknown to be set.
doms	: Array containing the index of the variable domains present in this space.

Reimplemented in Kadath::Space_bin_ns, Kadath::Space_bin_bh, Kadath::Space_bbh, Kadath::Space_polar_adapted, Kadath::Space_adapted_bh, and Kadath::Space_spheric_adapted.

Definition at line 1401 of file space.hpp.

◆ get_domain()

const Domain* Kadath::Space::get_domain ( int i ) const

inline

returns a pointer on the domain.

Parameters

i	[input] : the index of the domain.

Definition at line 1385 of file space.hpp.

References domains, and nbr_domains.

◆ get_indices_matching_non_std()

Array< int > Kadath::Space::get_indices_matching_non_std	(	int	dom,
		int	bound
	)		const

virtual

Gives the number of the other domains, touching a given boundary.

It also gives the name of the boundary, as seen by the other domain.

Parameters

dom	: the domain considered.
bound	: the boundary.

Returns: a 2d-array containing the numbers of the other domains (stored in (0,i)) and the names of the boundary (stored in (1,i)).

Reimplemented in Kadath::Space_spheric, Kadath::Space_critic, Kadath::Space_bispheric, Kadath::Space_spheric_adapted, Kadath::Space_bin_ns, Kadath::Space_bin_fake, Kadath::Space_bin_bh, and Kadath::Space_bbh.

Definition at line 66 of file space.cpp.

◆ get_nbr_domains()

int Kadath::Space::get_nbr_domains ( ) const

inline

Returns the number of Domains.

Definition at line 1375 of file space.hpp.

References nbr_domains.

◆ get_ndim()

int Kadath::Space::get_ndim ( ) const

inline

Returns the number of dimensions.

Definition at line 1373 of file space.hpp.

References ndim.

◆ get_type_base()

int Kadath::Space::get_type_base ( ) const

inline

Returns the type of basis.

Definition at line 1377 of file space.hpp.

References type_base.

◆ nbr_unknowns_from_variable_domains()

virtual int Kadath::Space::nbr_unknowns_from_variable_domains ( ) const

inlinevirtual

Gives the number of unknowns coming from the variable shape of the domain.

Reimplemented in Kadath::Space_bin_ns, Kadath::Space_bin_bh, Kadath::Space_bbh, Kadath::Space_polar_adapted, Kadath::Space_adapted_bh, and Kadath::Space_spheric_adapted.

Definition at line 1394 of file space.hpp.

◆ save()

void Kadath::Space::save ( FILE * ) const

virtual

Saving function.

Reimplemented in Kadath::Space_spheric_time, Kadath::Space_spheric_symphi, Kadath::Space_spheric_periodic, Kadath::Space_spheric, Kadath::Space_polar_periodic, Kadath::Space_polar, Kadath::Space_oned, Kadath::Space_fourD_periodic, Kadath::Space_critic, Kadath::Space_bispheric, Kadath::Space_bin_ns, Kadath::Space_bin_fake, Kadath::Space_bin_bh, Kadath::Space_bbh, Kadath::Space_polar_adapted, Kadath::Space_adapted_bh, and Kadath::Space_spheric_adapted.

Definition at line 60 of file space.cpp.

◆ xx_to_ders_variable_domains()

virtual void Kadath::Space::xx_to_ders_variable_domains	(	const Array< double > &	xx,
		int &	conte
	)		const

inlinevirtual

Update the vairable domains from a set of values.

Parameters

xx	: set of values used by the affectation
conte	: current position in the values vector.

Reimplemented in Kadath::Space_bin_ns, Kadath::Space_bin_bh, Kadath::Space_bbh, Kadath::Space_polar_adapted, Kadath::Space_adapted_bh, and Kadath::Space_spheric_adapted.

Definition at line 1407 of file space.hpp.

◆ xx_to_vars_variable_domains()

virtual void Kadath::Space::xx_to_vars_variable_domains	(	System_of_eqs *	syst,
		const Array< double > &	xx,
		int &	conte
	)		const

inlinevirtual

Update the variables of a system, from the variation of the shape of the domains.

Parameters

syst	: the `System_of_eqs` considered.
xx	: set of values used by the affectation
conte	: current position in the values vector.

Reimplemented in Kadath::Space_bin_ns, Kadath::Space_bin_bh, Kadath::Space_bbh, Kadath::Space_polar_adapted, Kadath::Space_adapted_bh, and Kadath::Space_spheric_adapted.

Definition at line 1414 of file space.hpp.

Friends And Related Function Documentation

◆ operator<<

ostream& operator<<	(	ostream &	o,
		const Space &	so
	)

friend

Display.

Definition at line 39 of file space.cpp.

Member Data Documentation

◆ domains

Domain** Kadath::Space::domains

protected

Pointers on the various Domains.

Definition at line 1368 of file space.hpp.

◆ nbr_domains

int Kadath::Space::nbr_domains

protected

Number od Domains.

Definition at line 1365 of file space.hpp.

◆ ndim

int Kadath::Space::ndim

protected

Number of dimensions (should be the same for all the Domains).

Definition at line 1366 of file space.hpp.

◆ type_base

int Kadath::Space::type_base

protected

Type of basis used (i.e. using either Chebyshev or Legendre polynomials).

Definition at line 1367 of file space.hpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Space()

◆ ~Space()

Member Function Documentation

◆ affecte_coef_to_variable_domains()

◆ get_domain()

◆ get_indices_matching_non_std()

◆ get_nbr_domains()

◆ get_ndim()

◆ get_type_base()

◆ nbr_unknowns_from_variable_domains()

◆ save()

◆ xx_to_ders_variable_domains()

◆ xx_to_vars_variable_domains()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ domains

◆ nbr_domains

◆ ndim

◆ type_base