Operateur_Conv Generic class of the hierarchy of operators representing a convection term. More...

#include <Operateur_Conv.h>

Inheritance diagram for Operateur_Conv:

Collaboration diagram for Operateur_Conv:

Public Member Functions
Operateur_base &	l_op_base () override
	Returns the underlying object upcast to Operateur_base.
const Operateur_base &	l_op_base () const override
	Returns the underlying object upcast to Operateur_base (const version).
DoubleTab &	ajouter (const DoubleTab &, DoubleTab &) const override
	Adds the contribution of the operator to the array passed as parameter.
DoubleTab &	calculer (const DoubleTab &, DoubleTab &) const override
	Initializes the array passed as parameter with the contribution of the operator.
void	associer_vitesse (const Champ_base &)
	Associates the velocity (as the transporting velocity) to the convection operator.
const Champ_base &	vitesse () const
	Returns the transporting velocity of the operator.
void	typer () override
	Types the operator: "Op_Conv" + keyword + discretisation + unknown.
void	typer (const Nom &)
	Types the operator.
int	op_non_nul () const override
void	associer_norme_vitesse (const Champ_base &)
Public Member Functions inherited from Operateur
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	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)
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_base) la_vitesse
Protected Member Functions inherited from Operateur
	OBS_PTR (Champ_Inc_base) le_champ_inco
Protected Member Functions inherited from MorEqn
	OBS_PTR (Equation_base) mon_equation
virtual	~MorEqn ()

Additional Inherited Members
Protected Attributes inherited from Operateur
std::string	nom_inco_
Motcle	typ

Detailed Description

Operateur_Conv Generic class of the hierarchy of operators representing a convection term.

An Operateur_Conv object can reference any object derived from Operateur_Conv_base.

See also: Operateur_Conv_base Operateur

Definition at line 33 of file Operateur_Conv.h.

Member Function Documentation

◆ ajouter()

DoubleTab & Operateur_Conv::ajouter	(	const DoubleTab &	donnee,
		DoubleTab &	resu ) const

overridevirtual

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

Parameters

(DoubleTab&	donnee) array containing the data on which the operator is applied.
(DoubleTab&	resu) array to which the contribution of the operator is added

Returns: (DoubleTab&) the array containing the result

Implements Operateur.

Definition at line 91 of file Operateur_Conv.cpp.

◆ associer_norme_vitesse()

void Operateur_Conv::associer_norme_vitesse ( const Champ_base & norme_vitesse )

Definition at line 115 of file Operateur_Conv.cpp.

◆ associer_vitesse()

void Operateur_Conv::associer_vitesse ( const Champ_base & vit )

inline

Associates the velocity (as the transporting velocity) to the convection operator.

Parameters

(Champ_Inc_base& vit) the unknown field representing the velocity

Returns: the unknown field representing the transporting velocity

Definition at line 75 of file Operateur_Conv.h.

◆ calculer()

DoubleTab & Operateur_Conv::calculer	(	const DoubleTab &	donnee,
		DoubleTab &	resu ) const

overridevirtual

Initializes the array passed as parameter with the contribution of the operator.

Parameters

(DoubleTab&	donnee) array containing the data on which the operator is applied.
(DoubleTab&	resu) array in which the contribution of the operator is stored

Returns: (DoubleTab&) the array containing the result

Implements Operateur.

Definition at line 106 of file Operateur_Conv.cpp.

◆ l_op_base() [1/2]

const Operateur_base & Operateur_Conv::l_op_base ( ) const

inlineoverridevirtual

Returns the underlying object upcast to Operateur_base (const version).

Returns: (Operateur_base&) the underlying object upcast to Operateur_base

Implements Operateur.

Definition at line 65 of file Operateur_Conv.h.

◆ l_op_base() [2/2]

Operateur_base & Operateur_Conv::l_op_base ( )

inlineoverridevirtual

Returns the underlying object upcast to Operateur_base.

Returns: (Operateur_base&) the underlying object upcast to Operateur_base

Implements Operateur.

Definition at line 57 of file Operateur_Conv.h.

◆ OBS_PTR()

Operateur_Conv::OBS_PTR ( Champ_base )

protected

◆ op_non_nul()

int Operateur_Conv::op_non_nul ( ) const

inlineoverridevirtual

Implements Operateur.

Definition at line 100 of file Operateur_Conv.h.

◆ typer() [1/2]

void Operateur_Conv::typer ( )

overridevirtual

Types the operator: "Op_Conv" + keyword + discretisation + unknown.

Associates the transporting velocity to the base operator

Implements Operateur.

Definition at line 71 of file Operateur_Conv.cpp.

◆ typer() [2/2]

void Operateur_Conv::typer ( const Nom & a_type )

inline

Types the operator.

Parameters

(Nom& typ) the name representing the type of the operator

Definition at line 95 of file Operateur_Conv.h.

◆ vitesse()

const Champ_base & Operateur_Conv::vitesse ( ) const

inline

Returns the transporting velocity of the operator.

Returns: (Champ_Inc_base&) the unknown field representing the transporting velocity

Definition at line 84 of file Operateur_Conv.h.

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

/home/docs/trust-code/src/Kernel/Operateurs/Operateur_Conv.h
/home/docs/trust-code/src/Kernel/Operateurs/Operateur_Conv.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ajouter()

◆ associer_norme_vitesse()

◆ associer_vitesse()

◆ calculer()

◆ l_op_base() [1/2]

◆ l_op_base() [2/2]

◆ OBS_PTR()

◆ op_non_nul()

◆ typer() [1/2]

◆ typer() [2/2]

◆ vitesse()