Arcane::IVariableUtilities Class Reference

Interface providing utility functions on variables. More...

#include <arcane/core/IVariableUtilities.h>

Inheritance diagram for Arcane::IVariableUtilities:

Collaboration diagram for Arcane::IVariableUtilities:

Public Member Functions
virtual	~IVariableUtilities ()=default
	Frees resources.
virtual IVariableMng *	variableMng () const =0
	Associated variable manager.
virtual void	dumpDependencies (IVariable *var, std::ostream &ostr, bool is_recursive)=0
	Displays dependency information for a variable.
virtual void	dumpAllVariableDependencies (std::ostream &ostr, bool is_recursive)=0
	Displays dependency information for all variables.
virtual VariableCollection	filterCommonVariables (IParallelMng *pm, VariableCollection input_variables, bool dump_not_common)=0
	Filters common variables between multiple ranks.

Detailed Description

Interface providing utility functions on variables.

Definition at line 31 of file IVariableUtilities.h.

Member Function Documentation

dumpAllVariableDependencies()

virtual void Arcane::IVariableUtilities::dumpAllVariableDependencies ( std::ostream & ostr, bool is_recursive )

pure virtual

Displays dependency information for all variables.

Displays on the stream ostr the information of all used variables.

Implemented in Arcane::VariableUtilities.

dumpDependencies()

virtual void Arcane::IVariableUtilities::dumpDependencies ( IVariable * var, std::ostream & ostr, bool is_recursive )

pure virtual

Displays dependency information for a variable.

Displays on the stream ostr the information about the variables that depend on var. If is_recursive is true, this method is also called for these variables.

Implemented in Arcane::VariableUtilities.

filterCommonVariables()

virtual VariableCollection Arcane::IVariableUtilities::filterCommonVariables ( IParallelMng * pm, VariableCollection input_variables, bool dump_not_common )

pure virtual

Filters common variables between multiple ranks.

This method allows filtering the variables in input_variables that are present on all ranks of pm. It returns the list sorted alphabetically of variables common to all ranks.

If dump_no_common is true, it displays (via ITraceMng::info()) the list of variables that are not common on all ranks.

Implemented in Arcane::VariableUtilities.

Referenced by Arcane::ArcaneBasicVerifierService::doVerifFromReferenceFile().

Here is the caller graph for this function:

variableMng()

virtual IVariableMng * Arcane::IVariableUtilities::variableMng ( ) const

pure virtual

Associated variable manager.

Implemented in Arcane::VariableUtilities.

---

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

• IVariableUtilities.h