Support_Champ_Masse_Volumique Class Reference

#include <Support_Champ_Masse_Volumique.h>

Inheritance diagram for Support_Champ_Masse_Volumique:

Public Member Functions
	Support_Champ_Masse_Volumique ()
	Constructor of the class.
virtual	~Support_Champ_Masse_Volumique ()
	Virtual destructor (to avoid warnings).
virtual void	associer_champ_masse_volumique (const Champ_base &)
	Method to be called during problem preparation to ask the object to take into account the density field passed as parameter.
virtual void	dissocier_champ_masse_volumique ()
	Cancels the reference to the density field.
virtual int	has_champ_masse_volumique () const
	Returns 1 if the density field has been associated, 0 otherwise.
virtual const Champ_base &	get_champ_masse_volumique () const
	Returns the density field.
const int &	support_ok () const

Protected Member Functions
virtual void	declare_support_masse_volumique (int ok)
	The constructor of a derived class that uses the density field must call this function with the value 1.

Detailed Description

Definition at line 23 of file Support_Champ_Masse_Volumique.h.

Constructor & Destructor Documentation

Support_Champ_Masse_Volumique()

Support_Champ_Masse_Volumique::Support_Champ_Masse_Volumique

(

)

Constructor of the class.

By default, an already coded derived class calls the constructor without argument. support_ok is set to zero and an error is produced if Associer_champ_masse_volumique is called. To indicate that the density field is supported by the derived class, call Declare_support_masse_volumique

Definition at line 27 of file Support_Champ_Masse_Volumique.cpp.

~Support_Champ_Masse_Volumique()

Support_Champ_Masse_Volumique::~Support_Champ_Masse_Volumique ( )

virtual

Virtual destructor (to avoid warnings).

Definition at line 35 of file Support_Champ_Masse_Volumique.cpp.

Member Function Documentation

associer_champ_masse_volumique()

void Support_Champ_Masse_Volumique::associer_champ_masse_volumique ( const Champ_base & ch )

virtual

Method to be called during problem preparation to ask the object to take into account the density field passed as parameter.

Reimplemented in Op_Diff_negligeable.

Definition at line 54 of file Support_Champ_Masse_Volumique.cpp.

declare_support_masse_volumique()

void Support_Champ_Masse_Volumique::declare_support_masse_volumique ( int ok )

protectedvirtual

The constructor of a derived class that uses the density field must call this function with the value 1.

If a client class (Navier Stokes for example) tries to associate the density field to a class that has not set ok=1, it stops: function not implemented.

Definition at line 46 of file Support_Champ_Masse_Volumique.cpp.

dissocier_champ_masse_volumique()

void Support_Champ_Masse_Volumique::dissocier_champ_masse_volumique ( )

virtual

Cancels the reference to the density field.

Definition at line 69 of file Support_Champ_Masse_Volumique.cpp.

get_champ_masse_volumique()

const Champ_base & Support_Champ_Masse_Volumique::get_champ_masse_volumique ( ) const

virtual

Returns the density field.

Definition at line 87 of file Support_Champ_Masse_Volumique.cpp.

has_champ_masse_volumique()

int Support_Champ_Masse_Volumique::has_champ_masse_volumique ( ) const

virtual

Returns 1 if the density field has been associated, 0 otherwise.

Definition at line 78 of file Support_Champ_Masse_Volumique.cpp.

support_ok()

const int & Support_Champ_Masse_Volumique::support_ok ( ) const

inline

Definition at line 45 of file Support_Champ_Masse_Volumique.h.

---

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

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