The Space_critic ; set the space with two critic domains, separated at $x_{\rm lim}$ . More...

#include <critic.hpp>

Inheritance diagram for Kadath::Space_critic:

Public Member Functions
	Space_critic (int ttype, double xl, const Dim_array &nbr_inner, const Dim_array &nbr_outer)
	Standard constructor. More...

	Space_critic (FILE *)
	Constructor from a file. More...

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

void	add_bc_zero (System_of_eqs &syst, const char eq, int nused=-1, Array< int > *pused=0x0)
	Sets a boundary condition at . More...

void	add_bc_one (System_of_eqs &syst, const char eq, int nused=-1, Array< int > *pused=0x0)
	Sets a boundary condition at . More...

void	add_eq_zero_mode_center (System_of_eqs &syst, const char *f, int jtarget)
	Adds an equation saying that one coefficient of a field is zero (at $x_{\rm lim}$ ) More...

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

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...

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...

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...

Detailed Description

The Space_critic ; set the space with two critic domains, separated at $x_{\rm lim}$ .

Definition at line 329 of file critic.hpp.

Constructor & Destructor Documentation

◆ Space_critic() [1/2]

Kadath::Space_critic::Space_critic	(	int	ttype,
		double	xl,
		const Dim_array &	nbr_inner,
		const Dim_array &	nbr_outer
	)

Standard constructor.

Parameters

ttype	[input] : the type of basis.
xl	[input] : $x_{\rm lim}$ .
nbr_inner	[input] : number of points in the inner domain.
nbr_outer	[input] : number of points in the outer domain.

Definition at line 27 of file space_critic.cpp.

References Kadath::Space::domains, Kadath::Space::nbr_domains, Kadath::Space::ndim, and Kadath::Space::type_base.

◆ Space_critic() [2/2]

Kadath::Space_critic::Space_critic ( FILE * fd )

Constructor from a file.

Definition at line 40 of file space_critic.cpp.

References Kadath::Space::domains, Kadath::Space::nbr_domains, Kadath::Space::ndim, and Kadath::Space::type_base.

Member Function Documentation

◆ add_bc_one()

void Kadath::Space_critic::add_bc_one	(	System_of_eqs &	syst,
		const char *	eq,
		int	nused = `-1`,
		Array< int > **	pused = `0x0`
	)

Sets a boundary condition at $ X=1 $ .

Parameters

syst	: the `System_of_eqs`.
eq	: the string describing the boundary condition.
nused	: number of components of `eq` to be considered. All the components are used of it is -1.
pused	: pointer on the indexes of the components to be considered. Not used of nused = -1 .

Definition at line 29 of file critic_add_eq.cpp.

References Kadath::System_of_eqs::add_eq_bc().

◆ add_bc_zero()

void Kadath::Space_critic::add_bc_zero	(	System_of_eqs &	syst,
		const char *	eq,
		int	nused = `-1`,
		Array< int > **	pused = `0x0`
	)

Sets a boundary condition at $ X=0$ .

Parameters

syst	: the `System_of_eqs`.
eq	: the string describing the boundary condition.
nused	: number of components of `eq` to be considered. All the components are used of it is -1.
pused	: pointer on the indexes of the components to be considered. Not used of nused = -1 .

Definition at line 25 of file critic_add_eq.cpp.

References Kadath::System_of_eqs::add_eq_bc().

◆ add_eq_zero_mode_center()

void Kadath::Space_critic::add_eq_zero_mode_center	(	System_of_eqs &	syst,
		const char *	f,
		int	jtarget
	)

Adds an equation saying that one coefficient of a field is zero (at $x_{\rm lim}$ )

Parameters

syst	: the `System_of_eqs`.
f	: the field
jtarget	: the index of the mode that must vanish.

Definition at line 33 of file critic_add_eq.cpp.

References Kadath::System_of_eqs::add_eq_mode(), Kadath::Space::domains, and Kadath::Index::set().

◆ affecte_coef_to_variable_domains()

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

inlinevirtualinherited

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

inlineinherited

returns a pointer on the domain.

Parameters

i	[input] : the index of the domain.

Definition at line 1385 of file space.hpp.

References Kadath::Space::domains, and Kadath::Space::nbr_domains.

◆ get_indices_matching_non_std()

Array< int > Kadath::Space_critic::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 from Kadath::Space.

Definition at line 61 of file space_critic.cpp.

References Kadath::Array< T >::set().

◆ get_nbr_domains()

int Kadath::Space::get_nbr_domains ( ) const

inlineinherited

Returns the number of Domains.

Definition at line 1375 of file space.hpp.

References Kadath::Space::nbr_domains.

◆ get_ndim()

int Kadath::Space::get_ndim ( ) const

inlineinherited

Returns the number of dimensions.

Definition at line 1373 of file space.hpp.

References Kadath::Space::ndim.

◆ get_type_base()

int Kadath::Space::get_type_base ( ) const

inlineinherited

Returns the type of basis.

Definition at line 1377 of file space.hpp.

References Kadath::Space::type_base.

◆ nbr_unknowns_from_variable_domains()

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

inlinevirtualinherited

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_critic::save ( FILE * ) const

virtual

Saving function.

Reimplemented from Kadath::Space.

Definition at line 54 of file space_critic.cpp.

References Kadath::Space::domains, Kadath::Space::ndim, Kadath::Domain::save(), and Kadath::Space::type_base.

◆ xx_to_ders_variable_domains()

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

inlinevirtualinherited

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

inlinevirtualinherited

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.

Member Data Documentation

◆ domains

Domain** Kadath::Space::domains

protectedinherited

Pointers on the various Domains.

Definition at line 1368 of file space.hpp.

◆ nbr_domains

int Kadath::Space::nbr_domains

protectedinherited

Number od Domains.

Definition at line 1365 of file space.hpp.

◆ ndim

int Kadath::Space::ndim

protectedinherited

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

protectedinherited

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 Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Space_critic() [1/2]

◆ Space_critic() [2/2]

Member Function Documentation

◆ add_bc_one()

◆ add_bc_zero()

◆ add_eq_zero_mode_center()

◆ 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()

Member Data Documentation

◆ domains

◆ nbr_domains

◆ ndim

◆ type_base