Equation for describing a first integral equation (i.e. More...

#include <system_of_eqs.hpp>

Inheritance diagram for Kadath::Eq_first_integral:

Public Member Functions
	Eq_first_integral (const System_of_eqs syst, const Domain dom, int dommin, int dommax, const char integ_part, const char const_part)
	Constructor. More...

virtual	~Eq_first_integral ()
	Destructor. More...

void	export_val (int &, Term_eq **, Array< double > &, int &) const override
	Generates the discretized errors, from the various `Term_eq` computed by the equation. More...

void	export_der (int &, Term_eq **, Array< double > &, int &) const override
	Generates the discretized variations, from the various `Term_eq` computed by the equation. More...

Array< int >	do_nbr_conditions (const Tensor &tt) const override
	Computes the number of conditions associated with the equation. More...

bool	take_into_account (int) const override
	Check whether the variation of the residual has to be taken into account when computing a given column. More...

int	get_n_cond_tot () const

virtual void	apply (int &conte, Term_eq **res)
	Computes the terms involved in computing the residual of the equations. More...

Public Attributes
int	dom_min
	Index of the first `Domain`. More...

int	dom_max
	Index of the last `Domain`. More...

Protected Attributes
const Domain *	dom
	Pointer on the `Domain` where the equation is defined. More...

int	ndom
	Number of the domain. More...

int	n_ope
	Number of terms involved in the equation (one for bulk, two or more fot matching...). More...

MMPtr_array< Ope_eq >	parts
	Array of pointers on the various terms. More...

bool	called
	Indicator checking whther the result has been computed already once. More...

int	n_comp
	Number of components of the residual (1 for a scalar, 6 for a symmetric rank-2 tensor etc). More...

int	n_cond_tot
	Total number of discretized equations (essentially the number of all coefficients of the residual). More...

Array< int > *	n_cond
	Number of discretized equations, component by component. More...

int	n_cmp_used
	Number of components used (by default the same thing as `n_comp`). More...

Array< int > **	p_cmp_used
	Array of pointer on the indices of the used components. More...

Detailed Description

Equation for describing a first integral equation (i.e.

a constant quantity in some domains).

Definition at line 1626 of file system_of_eqs.hpp.

Constructor & Destructor Documentation

◆ Eq_first_integral()

Kadath::Eq_first_integral::Eq_first_integral	(	const System_of_eqs *	syst,
		const Domain *	dom,
		int	dommin,
		int	dommax,
		const char *	integ_part,
		const char *	const_part
	)

Constructor.

Parameters

syst	: Pointer on the associated `System_of_eqs`
dom	: Pointer on the first `Domain` (needed for `Equation` constructor)
dommin	: index of the first `Domain` (consistence is not checked).
dommax	: index of the last `Domain`
integ_part	: name of the integral quantity
const_part	: equation fixing the value of the integral.

Definition at line 27 of file eq_first_integral.cpp.

References dom_max, dom_min, Kadath::System_of_eqs::give_ope(), and Kadath::Equation::parts.

◆ ~Eq_first_integral()

Kadath::Eq_first_integral::~Eq_first_integral ( )

virtual

Destructor.

Definition at line 43 of file eq_first_integral.cpp.

Member Function Documentation

◆ apply()

void Kadath::Equation::apply	(	int &	conte,
		Term_eq **	res
	)

virtualinherited

Computes the terms involved in computing the residual of the equations.

Parameters

conte	: current position in the array of terms.
res	: array of pointers on the various terms.

Reimplemented in Kadath::Eq_matching_non_std.

Definition at line 49 of file equation.cpp.

References Kadath::Equation::called, Kadath::Equation::do_nbr_conditions(), Kadath::Array< T >::get_size(), Kadath::Equation::n_comp, Kadath::Equation::n_cond, Kadath::Equation::n_cond_tot, Kadath::Equation::n_ope, and Kadath::Equation::parts.

◆ do_nbr_conditions()

Array< int > Kadath::Eq_first_integral::do_nbr_conditions ( const Tensor & tt ) const

overridevirtual

Computes the number of conditions associated with the equation.

Parameters

tt	: the residual of the equation.

Implements Kadath::Equation.

Definition at line 132 of file eq_first_integral.cpp.

References dom_max, dom_min, Kadath::Space::get_domain(), Kadath::Tensor::get_space(), Kadath::Domain::nbr_conditions(), Kadath::Equation::ndom, and Kadath::Array< T >::set().

◆ export_der()

void Kadath::Eq_first_integral::export_der	(	int &	conte,
		Term_eq **	residuals,
		Array< double > &	sec,
		int &	pos_sec
	)		const

overridevirtual

Generates the discretized variations, from the various Term_eq computed by the equation.

Basically used when computing the Jacobian of the Newton-Raphson algorithm.

Parameters

conte	: current position in the array of terms.
residuals	: array of pointers on the various terms.
sec	: array of the discretized errors.
pos_sec	: current position in `sec`.

Implements Kadath::Equation.

Definition at line 89 of file eq_first_integral.cpp.

References Kadath::Val_domain::coef_i(), dom_max, dom_min, Kadath::Domain::export_tau(), Kadath::Term_eq::get_der_t(), Kadath::Space::get_domain(), Kadath::Domain::get_nbr_points(), Kadath::Tensor::get_space(), Kadath::Term_eq::get_val_t(), Kadath::Index::inc(), Kadath::Equation::n_cond, Kadath::Val_domain::set(), and Kadath::Scalar::set_domain().

◆ export_val()

void Kadath::Eq_first_integral::export_val	(	int &	conte,
		Term_eq **	residuals,
		Array< double > &	sec,
		int &	pos_sec
	)		const

overridevirtual

Generates the discretized errors, from the various Term_eq computed by the equation.

Basically used when computing the second member of the Newton-Raphson algorithm.

Parameters

conte	: current position in the array of terms.
residuals	: array of pointers on the various terms.
sec	: array of the discretized errors.
pos_sec	: current position in `sec`.

Implements Kadath::Equation.

Definition at line 47 of file eq_first_integral.cpp.

References Kadath::Val_domain::coef_i(), dom_max, dom_min, Kadath::Domain::export_tau(), Kadath::Space::get_domain(), Kadath::Domain::get_nbr_points(), Kadath::Tensor::get_space(), Kadath::Term_eq::get_val_t(), Kadath::Index::inc(), Kadath::Equation::n_cond, Kadath::Val_domain::set(), and Kadath::Scalar::set_domain().

◆ get_n_cond_tot()

int Kadath::Equation::get_n_cond_tot ( ) const

inlineinherited

Returns: the total number of discretized conditions.

Definition at line 1095 of file system_of_eqs.hpp.

References Kadath::Equation::n_cond_tot.

◆ take_into_account()

bool Kadath::Eq_first_integral::take_into_account ( int target ) const

overridevirtual

Check whether the variation of the residual has to be taken into account when computing a given column.

Parameters

target : domain involved in the computation of the given column.

Implements Kadath::Equation.

Definition at line 141 of file eq_first_integral.cpp.

References dom_max, and dom_min.

Member Data Documentation

◆ called

bool Kadath::Equation::called

protectedinherited

Indicator checking whther the result has been computed already once.

If not the quantities n_cond must be computed.

Definition at line 1070 of file system_of_eqs.hpp.

◆ dom

const Domain* Kadath::Equation::dom

protectedinherited

Pointer on the Domain where the equation is defined.

Definition at line 1061 of file system_of_eqs.hpp.

◆ dom_max

int Kadath::Eq_first_integral::dom_max

Index of the last Domain.

Definition at line 1631 of file system_of_eqs.hpp.

◆ dom_min

int Kadath::Eq_first_integral::dom_min

Index of the first Domain.

Definition at line 1630 of file system_of_eqs.hpp.

◆ n_cmp_used

int Kadath::Equation::n_cmp_used

protectedinherited

Number of components used (by default the same thing as n_comp).

Definition at line 1075 of file system_of_eqs.hpp.

◆ n_comp

int Kadath::Equation::n_comp

protectedinherited

Number of components of the residual (1 for a scalar, 6 for a symmetric rank-2 tensor etc).

Definition at line 1071 of file system_of_eqs.hpp.

◆ n_cond

Array<int>* Kadath::Equation::n_cond

protectedinherited

Number of discretized equations, component by component.

Definition at line 1073 of file system_of_eqs.hpp.

◆ n_cond_tot

int Kadath::Equation::n_cond_tot

protectedinherited

Total number of discretized equations (essentially the number of all coefficients of the residual).

Definition at line 1072 of file system_of_eqs.hpp.

◆ n_ope

int Kadath::Equation::n_ope

protectedinherited

Number of terms involved in the equation (one for bulk, two or more fot matching...).

Definition at line 1063 of file system_of_eqs.hpp.

◆ ndom

int Kadath::Equation::ndom

protectedinherited

Number of the domain.

Definition at line 1062 of file system_of_eqs.hpp.

◆ p_cmp_used

Array<int>** Kadath::Equation::p_cmp_used

protectedinherited

Array of pointer on the indices of the used components.

Definition at line 1076 of file system_of_eqs.hpp.

◆ parts

MMPtr_array<Ope_eq> Kadath::Equation::parts

protectedinherited

Array of pointers on the various terms.

Definition at line 1064 of file system_of_eqs.hpp.

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

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Eq_first_integral()

◆ ~Eq_first_integral()

Member Function Documentation

◆ apply()

◆ do_nbr_conditions()

◆ export_der()

◆ export_val()

◆ get_n_cond_tot()

◆ take_into_account()

Member Data Documentation

◆ called

◆ dom

◆ dom_max

◆ dom_min

◆ n_cmp_used

◆ n_comp

◆ n_cond

◆ n_cond_tot

◆ n_ope

◆ ndom

◆ p_cmp_used

◆ parts