KADATH
Kadath::Eq_full Class Reference

Class for a zeroth order equation in a Domain. More...

#include <system_of_eqs.hpp>

Inheritance diagram for Kadath::Eq_full:
Kadath::Equation

Public Member Functions

 Eq_full (const Domain *dom, int nd, Ope_eq *ope, int n_cmp=-1, Array< int > **p_cmp=nullptr)
 Constructor. More...
 
virtual ~Eq_full ()
 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...
 

Protected Attributes

const Domaindom
 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_eqparts
 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

Class for a zeroth order equation in a Domain.

Should be used for equations without derivatives.

Definition at line 1451 of file system_of_eqs.hpp.

Constructor & Destructor Documentation

◆ Eq_full()

Kadath::Eq_full::Eq_full ( const Domain dom,
int  nd,
Ope_eq ope,
int  n_cmp = -1,
Array< int > **  p_cmp = nullptr 
)

Constructor.

Parameters
dom: Pointer on the Domain
nd: number of the Domain (consistence is not checked).
ope: pointer on the operator describing the equation.
n_cmp: number of components of eq to be considered. All the components are used of it is -1.
p_cmp: pointer on the indexes of the components to be considered. Not used of nused = -1 .

Definition at line 26 of file eq_full.cpp.

References Kadath::Equation::parts.

◆ ~Eq_full()

Kadath::Eq_full::~Eq_full ( )
virtual

Destructor.

Definition at line 30 of file eq_full.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_full::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 47 of file eq_full.cpp.

References Kadath::Equation::dom, Kadath::Equation::n_cmp_used, Kadath::Domain::nbr_conditions(), Kadath::Equation::ndom, and Kadath::Equation::p_cmp_used.

◆ export_der()

void Kadath::Eq_full::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 40 of file eq_full.cpp.

References Kadath::Equation::dom, Kadath::Domain::export_tau(), Kadath::Equation::n_cmp_used, Kadath::Equation::n_cond, Kadath::Equation::ndom, and Kadath::Equation::p_cmp_used.

◆ export_val()

void Kadath::Eq_full::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 33 of file eq_full.cpp.

References Kadath::Equation::dom, Kadath::Domain::export_tau(), Kadath::Equation::n_cmp_used, Kadath::Equation::n_cond, Kadath::Equation::ndom, and Kadath::Equation::p_cmp_used.

◆ 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_full::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 51 of file eq_full.cpp.

References Kadath::Equation::ndom.

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.

◆ 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: