class Operateur Generic class of the operator hierarchy. More...

#include <Operateur.h>

Inheritance diagram for Operateur:

Collaboration diagram for Operateur:

Public Member Functions
virtual Operateur_base &	l_op_base ()=0
virtual const Operateur_base &	l_op_base () const =0
virtual DoubleTab &	ajouter (const DoubleTab &, DoubleTab &) const =0
virtual DoubleTab &	calculer (const DoubleTab &, DoubleTab &) const =0
DoubleTab &	ajouter (const Champ_Inc_base &, DoubleTab &) const
	Computes and adds the contribution of the operator to the right-hand side of the equation.
DoubleTab &	calculer (const Champ_Inc_base &, DoubleTab &) const
	Computes the contribution of the operator and returns the array of values.
DoubleTab &	ajouter (DoubleTab &) const
	Adds the contribution of the operator to the array passed as parameter.
DoubleTab &	calculer (DoubleTab &) const
	Applies the operator to the unknown field and returns the result.
const Nom &	type () const
	Returns the (name of the) type of operator to create.
double	calculer_pas_de_temps () const
	Computes the next time step.
void	calculer_pas_de_temps_locaux (DoubleTab &) const
	Calculate the next local time steps.
int	impr (Sortie &os) const
	Prints the operator to an output stream unconditionally.
virtual void	typer ()=0
virtual void	completer ()
	Updates the references of the objects associated with the operator.
virtual void	mettre_a_jour (double temps)
	Performs a time update of the operator.
const Champ_Inc_base &	mon_inconnue () const
	Returns the field representing the unknown of the equation to which the operator belongs.
const Discretisation_base &	discretisation () const
	Returns the discretization of the equation to which the operator belongs.
int	limpr () const
	Asks the equation whether printing is needed. Returns 1 for YES, 0 otherwise.
void	imprimer (Sortie &os) const
	Prints the operator to an output stream, if necessary.
Sortie &	ecrire (Sortie &) const
Entree &	lire (Entree &)
	Reads an operator from an input stream.
void	ajouter_contribution_explicite_au_second_membre (const Champ_Inc_base &inconnue, DoubleTab &derivee) const
void	associer_champ (const Champ_Inc_base &, const std::string &nom_ch)
void	set_fichier (const Nom &nom)
void	set_description (const Nom &nom)
virtual int	op_non_nul () const =0
Public Member Functions inherited from MorEqn
void	associer_eqn (const Equation_base &)
	Associates an equation with the object.
virtual void	calculer_pour_post (Champ_base &espace_stockage, const Nom &option, int comp) const
virtual Motcle	get_localisation_pour_post (const Nom &option) const
const Equation_base &	equation () const
	Returns the reference to the equation pointed to by MorEqn::mon_equation.
Equation_base &	equation ()
	Returns the reference to the equation pointed to by MorEqn::mon_equation.
int	mon_equation_non_nul () const
virtual void	check_multiphase_compatibility () const

Protected Member Functions
	OBS_PTR (Champ_Inc_base) le_champ_inco
Protected Member Functions inherited from MorEqn
	OBS_PTR (Equation_base) mon_equation
virtual	~MorEqn ()

Protected Attributes
std::string	nom_inco_
Motcle	typ

Detailed Description

class Operateur Generic class of the operator hierarchy.

This generic class is special because it does NOT INHERIT
from OWN_PTR(Operateur_base) but from MorEqn.
A reference to an Operateur_base is returned by the method
Operateur::l_op_base() which is pure virtual and must be overridden
in derived classes.

See also: MorEqn Operateur_base, Abstract class, Abstract methods:, Operateur_base& l_op_base(), const Operateur_base& l_op_base() const, DoubleTab& calculer(const DoubleTab&,DoubleTab& ) const, DoubleTab& calculer(const DoubleTab&,DoubleTab& ) const

Definition at line 38 of file Operateur.h.

Member Function Documentation

◆ ajouter() [1/3]

DoubleTab & Operateur::ajouter	(	const Champ_Inc_base &	ch,
		DoubleTab &	resu ) const

Computes and adds the contribution of the operator to the right-hand side of the equation.

Calls Operateur::ajouter(const DoubleTab&, DoubleTab& )

Parameters

	(Champ_Inc_base&	ch) the unknown field on which the operator acts
[in,out]	(DoubleTab&	resu) the array storing the right-hand side values to which the operator contribution is added

Returns: (DoubleTab&) the right-hand side to which the operator contribution has been added

Definition at line 231 of file Operateur.cpp.

◆ ajouter() [2/3]

virtual DoubleTab & Operateur::ajouter	(	const DoubleTab &	,
		DoubleTab &	) const

pure virtual

Implemented in Op_Diff_Fluctu_Temp, Op_Diff_Flux_Chaleur_Turb, Operateur_Conv, Operateur_Diff, Operateur_Div, Operateur_Evanescence, Operateur_Grad, and Operateur_NConserv.

◆ ajouter() [3/3]

DoubleTab & Operateur::ajouter ( DoubleTab & resu ) const

Adds the contribution of the operator to the array passed as parameter.

Calls Operateur::ajouter(const Champ_Inc_base&, DoubleTab& )

Parameters

(DoubleTab& resu) the array storing the right-hand side values to which the operator contribution is added

Returns: (DoubleTab&) the right-hand side to which the operator contribution has been added

Definition at line 283 of file Operateur.cpp.

◆ ajouter_contribution_explicite_au_second_membre()

void Operateur::ajouter_contribution_explicite_au_second_membre	(	const Champ_Inc_base &	inconnue,
		DoubleTab &	derivee ) const

Definition at line 311 of file Operateur.cpp.

◆ associer_champ()

void Operateur::associer_champ	(	const Champ_Inc_base &	ch,
		const std::string &	nom_ch )

Definition at line 152 of file Operateur.cpp.

◆ calculer() [1/3]

DoubleTab & Operateur::calculer	(	const Champ_Inc_base &	ch,
		DoubleTab &	resu ) const

Computes the contribution of the operator and returns the array of values.

Parameters

(Champ_Inc_base&	ch) the unknown field on which the operator acts
(DoubleTab&	resu) the array storing the values resulting from applying the operator to the unknown field.

Returns: (DoubleTab&) the result of applying the operator to the unknown field

Definition at line 271 of file Operateur.cpp.

◆ calculer() [2/3]

virtual DoubleTab & Operateur::calculer	(	const DoubleTab &	,
		DoubleTab &	) const

pure virtual

Implemented in Op_Diff_Fluctu_Temp, Op_Diff_Flux_Chaleur_Turb, Operateur_Conv, Operateur_Diff, Operateur_Div, Operateur_Evanescence, Operateur_Grad, and Operateur_NConserv.

◆ calculer() [3/3]

DoubleTab & Operateur::calculer ( DoubleTab & resu ) const

Applies the operator to the unknown field and returns the result.

Calls Operateur::calculer(const Champ_Inc_base&, DoubleTab& );

Parameters

(DoubleTab& resu) the array storing the values resulting from applying the operator to the unknown field.

Returns: (DoubleTab&) the result of applying the operator to the unknown field

Definition at line 295 of file Operateur.cpp.

◆ calculer_pas_de_temps()

double Operateur::calculer_pas_de_temps ( ) const

Computes the next time step.

Definition at line 172 of file Operateur.cpp.

◆ calculer_pas_de_temps_locaux()

void Operateur::calculer_pas_de_temps_locaux ( DoubleTab & dt_locaux ) const

Calculate the next local time steps.

Definition at line 187 of file Operateur.cpp.

◆ completer()

void Operateur::completer ( )

virtual

Updates the references of the objects associated with the operator.

Operateur::le_champ_inco, Operateur::champ_inco Calls Operateur_base::completer()

Reimplemented in Op_Diff_Fluctu_Temp, and Op_Diff_Flux_Chaleur_Turb.

Definition at line 144 of file Operateur.cpp.

◆ discretisation()

const Discretisation_base & Operateur::discretisation ( ) const

Returns the discretization of the equation to which the operator belongs.

Returns: (Discretisation_base&) the discretization of the associated equation

Definition at line 133 of file Operateur.cpp.

◆ ecrire()

Sortie & Operateur::ecrire ( Sortie & os ) const

Definition at line 24 of file Operateur.cpp.

◆ impr()

int Operateur::impr ( Sortie & os ) const

Prints the operator to an output stream unconditionally.

Parameters

(Sortie& os) the output stream for printing

Returns: (int) return code of Operateur_base::impr(Sortie&)

Definition at line 217 of file Operateur.cpp.

◆ imprimer()

void Operateur::imprimer ( Sortie & os ) const

Prints the operator to an output stream, if necessary.

(see Schema_Temp_base::limpr())

Parameters

(Sortie& os) the output stream for printing

Definition at line 206 of file Operateur.cpp.

◆ l_op_base() [1/2]

virtual const Operateur_base & Operateur::l_op_base ( ) const

pure virtual

Implemented in Op_Diff_Fluctu_Temp, Op_Diff_Flux_Chaleur_Turb, Operateur_Conv, Operateur_Diff, Operateur_Div, Operateur_Evanescence, Operateur_Grad, and Operateur_NConserv.

◆ l_op_base() [2/2]

virtual Operateur_base & Operateur::l_op_base ( )

pure virtual

Implemented in Op_Diff_Fluctu_Temp, Op_Diff_Flux_Chaleur_Turb, Operateur_Conv, Operateur_Diff, Operateur_Div, Operateur_Evanescence, Operateur_Grad, and Operateur_NConserv.

◆ limpr()

int Operateur::limpr ( ) const

Asks the equation whether printing is needed. Returns 1 for YES, 0 otherwise.

Returns: (int) 1 if printing is needed, 0 otherwise

Definition at line 195 of file Operateur.cpp.

◆ lire()

Entree & Operateur::lire ( Entree & is )

Reads an operator from an input stream.

Types the operator and associates its equation with it. Format: { [A KEYWORD REPRESENTING A TYPE] }

Parameters

(Entree& is) the input stream from which to read the operator

Returns: (Entree&) the modified input stream

Exceptions

opening	brace expected
closing	brace expected

Definition at line 44 of file Operateur.cpp.

◆ mettre_a_jour()

void Operateur::mettre_a_jour ( double temps )

virtual

Performs a time update of the operator.

Calls Operateur_base::mettre_a_jour(double)

Parameters

(double temps) the time step for update

Definition at line 165 of file Operateur.cpp.

◆ mon_inconnue()

const Champ_Inc_base & Operateur::mon_inconnue ( ) const

Returns the field representing the unknown of the equation to which the operator belongs.

Returns: (Champ_Inc_base&) the unknown field of the associated equation

Definition at line 124 of file Operateur.cpp.

◆ OBS_PTR()

Operateur::OBS_PTR ( Champ_Inc_base )

protected

◆ op_non_nul()

virtual int Operateur::op_non_nul ( ) const

pure virtual

Implemented in Op_Diff_Fluctu_Temp, Op_Diff_Flux_Chaleur_Turb, Operateur_Conv, Operateur_Diff, Operateur_Div, Operateur_Evanescence, Operateur_Grad, and Operateur_NConserv.

◆ set_description()

void Operateur::set_description ( const Nom & nom )

Definition at line 306 of file Operateur.cpp.

◆ set_fichier()

void Operateur::set_fichier ( const Nom & nom )

Definition at line 301 of file Operateur.cpp.

◆ type()

const Nom & Operateur::type ( ) const

Returns the (name of the) type of operator to create.

Returns: (Nom&) the name of the type of operator to create

Definition at line 259 of file Operateur.cpp.

◆ typer()

virtual void Operateur::typer ( )

pure virtual

Implemented in Op_Diff_Fluctu_Temp, Op_Diff_Flux_Chaleur_Turb, Operateur_Conv, Operateur_Diff, Operateur_Div, Operateur_Evanescence, Operateur_Grad, and Operateur_NConserv.

Member Data Documentation

◆ nom_inco_

std::string Operateur::nom_inco_

protected

Definition at line 74 of file Operateur.h.

◆ typ

Motcle Operateur::typ

protected

Definition at line 76 of file Operateur.h.

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

/home/docs/trust-code/src/Kernel/Framework/Operateur.h
/home/docs/trust-code/src/Kernel/Framework/Operateur.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ ajouter() [1/3]

◆ ajouter() [2/3]

◆ ajouter() [3/3]

◆ ajouter_contribution_explicite_au_second_membre()

◆ associer_champ()

◆ calculer() [1/3]

◆ calculer() [2/3]

◆ calculer() [3/3]

◆ calculer_pas_de_temps()

◆ calculer_pas_de_temps_locaux()

◆ completer()

◆ discretisation()

◆ ecrire()

◆ impr()

◆ imprimer()

◆ l_op_base() [1/2]

◆ l_op_base() [2/2]

◆ limpr()

◆ lire()

◆ mettre_a_jour()

◆ mon_inconnue()

◆ OBS_PTR()

◆ op_non_nul()

◆ set_description()

◆ set_fichier()

◆ type()

◆ typer()

Member Data Documentation

◆ nom_inco_

◆ typ