Instance of a variable. More...

#include <arcane/core/Variable.h>

Inheritance diagram for Arcane::Variable:

Collaboration diagram for Arcane::Variable:

Public Member Functions
	~Variable () override
	Frees resources.
	Variable (const Variable &from)=delete
	Copy constructor (do not use).
Variable &	operator= (const Variable &from)=delete
	Copy assignment operator (do not use).
ISubDomain *	subDomain () override
	Subdomain associated with the variable (TODO deprecate end of 2023).
IVariableMng *	variableMng () const override
	Variable manager associated with the variable.
String	fullName () const final
	Full variable name (with family prefix).
String	name () const final
	Variable name.
String	itemFamilyName () const final
	Name of the associated family (null if none).
String	meshName () const final
	Name of the associated mesh (null if none).
String	itemGroupName () const final
	Name of the associated entity group.
int	property () const override
void	notifyReferencePropertyChanged () override
void	setUsed (bool v) override
	Sets the usage state of the variable.
bool	isUsed () const override
	Usage state of the variable.
bool	isPartial () const override
	Indicates if the variable is partial.
void	setTraceInfo (Integer, eTraceType) override
void	read (IDataReader *d) override
void	write (IDataWriter *d) override
	Saves the variable.
void	notifyEndRead () override
	Notifies of external modification of data().
void	notifyBeginWrite () override
	Notifies of the start of writing data().
void	addVariableRef (VariableRef *ref) override
	Adds a reference to this variable.
void	removeVariableRef (VariableRef *ref) override
	Removes a reference to this variable.
VariableRef *	firstReference () const override
	First reference (or null) on this variable.
Integer	nbReference () const override
	Number of references on this variable.
VariableMetaData *	createMetaData () const override
	Creates an instance containing the variable's metadata.
Ref< VariableMetaData >	createMetaDataRef () const override
	Creates an instance containing the variable's metadata.
void	syncReferences () override
	Synchronizes references.
IMesh *	mesh () const final
	Mesh associated with the variable.
MeshHandle	meshHandle () const final
	Mesh associated with the variable.
ItemGroup	itemGroup () const final
	Associated mesh group.
IItemFamily *	itemFamily () const final
	Associated entity family.
eItemKind	itemKind () const override
	Kind of mesh entities on which the variable is based.
Integer	dimension () const override
	Dimension of the variable.
Integer	multiTag () const override
	Indicates if the variable is a multi-sized array.
Int32	checkIfSync (Integer max_print) final
	Checks if the variable is properly synchronized.
Int32	checkIfSameOnAllReplica (Integer max_print) final
	Checks if the variable has the same values on all replicas.
Int32	checkIfSame (IDataReader *reader, Integer max_print, bool compare_ghost) final
	Checks that the variable is identical to a reference value.
eDataType	dataType () const override
	Data type managed by the variable (Real, Integer, ...).
bool	initialize (const ItemGroup &, const String &) override
	Initializes the variable on a group.
IDataFactoryMng *	dataFactoryMng () const final
	Data factory associated with the variable.
void	serialize (ISerializer sbuffer, IDataOperation operation) override
void	serialize (ISerializer sbuffer, Int32ConstArrayView ids, IDataOperation operation) override
	Serializes the variable for identifiers ids.
void	resize (Integer n) override
	Sets the number of elements for an array variable.
void	resizeFromGroup () override
	Sets the number of elements for a mesh variable.
void	setAllocationInfo (const DataAllocationInfo &v) override
	Sets allocation information.
DataAllocationInfo	allocationInfo () const override
	Allocation information.
IObservable *	writeObservable () override
	Write observable.
IObservable *	readObservable () override
	Read observable.
IObservable *	onSizeChangedObservable () override
	Size change observable.
void	addTag (const String &tagname, const String &tagvalue) override
	Adds the tag tagname with the value tagvalue.
void	removeTag (const String &tagname) override
	Removes the tag tagname.
bool	hasTag (const String &tagname) override
	true if the variable has the tag tagname
String	tagValue (const String &tagname) override
	Value of the tag tagname. The string is null if the tag does not exist.
void	update () override
	Recalculates the variable if necessary.
void	setUpToDate () override
	Indicates that the variable has just been updated.
Int64	modifiedTime () override
	Time when the variable was updated.
void	addDepend (IVariable *var, eDependType dt) override
	Adds var to the list of dependencies.
void	addDepend (IVariable *var, eDependType dt, const TraceInfo &tinfo) override
	Adds var to the list of dependencies with trace info tinfo.
void	removeDepend (IVariable *var) override
	Removes var from the list of dependencies.
void	setComputeFunction (IVariableComputeFunction *v) override
	Sets the variable's recalculation function.
IVariableComputeFunction *	computeFunction () override
	Function used to update the variable.
void	dependInfos (Array< VariableDependInfo > &infos) override
	Dependency information.
void	update (Real wanted_time) override
void	changeGroupIds (Int32ConstArrayView old_to_new_ids) override
	pH: EXPERIMENTAL
IVariableInternal *	_internalApi () override
	Internal Arcane API.
IMemoryAccessTrace *	memoryAccessTrace () const override
Public Member Functions inherited from Arcane::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Constructs an accessor via the trace manager m.
	TraceAccessor (const TraceAccessor &rhs)
	Copy constructor.
TraceAccessor &	operator= (const TraceAccessor &rhs)
	Copy assignment operator.
virtual	~TraceAccessor ()
	Frees resources.
ITraceMng *	traceMng () const
	Trace manager.
TraceMessage	info () const
	Flow for an information message.
TraceMessage	pinfo () const
	Flow for a parallel information message.
TraceMessage	info (char category) const
	Flow for an information message of a given category.
TraceMessage	pinfo (char category) const
	Flow for a parallel information message of a given category.
TraceMessage	info (bool v) const
	Flow for an information message.
TraceMessage	warning () const
	Flow for a warning message.
TraceMessage	pwarning () const
TraceMessage	error () const
	Flow for an error message.
TraceMessage	perror () const
TraceMessage	log () const
	Flow for a log message.
TraceMessage	plog () const
	Flow for a log message.
TraceMessage	logdate () const
	Flow for a log message preceded by the date.
TraceMessage	fatal () const
	Flow for a fatal error message.
TraceMessage	pfatal () const
	Flow for a parallel fatal error message.
TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flow for a debug message.
Trace::eDebugLevel	configDbgLevel () const
	Debug level of the configuration file.
TraceMessage	info (Int32 verbose_level) const
	Flow for an information message of a given level.
TraceMessage	linfo () const
	Flow for an information message with the local information level of this instance.
TraceMessage	linfo (Int32 relative_level) const
	Flow for an information message with the local information level of this instance.
void	fatalMessage (const StandaloneTraceMessage &o) const
Public Member Functions inherited from Arcane::IVariable
virtual	~IVariable ()=default
	Frees resources.
virtual Real	allocatedMemory () const =0
	Memory size (in Bytes) used by the variable.
virtual Integer	nbElement () const =0
	Number of elements of the variable.
virtual void	shrinkMemory ()=0
	Frees any additional memory allocated for the data.
virtual void	synchronize ()=0
	Synchronizes the variable.
virtual void	synchronize (Int32ConstArrayView local_ids)
	Synchronizes the variable on a list of entities.
virtual void	copyItemsValues (Int32ConstArrayView source, Int32ConstArrayView destination)=0
	Copies the values of entities numbered source into entities numbered destination.
virtual void	copyItemsMeanValues (Int32ConstArrayView first_source, Int32ConstArrayView second_source, Int32ConstArrayView destination)=0
	Copies the mean values of entities numbered first_source and second_source into entities numbered destination.
virtual void	compact (Int32ConstArrayView new_to_old_ids)=0
	Compresses the variable's values.
virtual IData *	data ()=0
	Data associated with the variable.
virtual const IData *	data () const =0
	Data associated with the variable.
virtual void	print (std::ostream &o) const =0
	Prints the variable's values to the stream o.
virtual void	setIsSynchronized ()=0
	Indicates that the variable is synchronized.
virtual void	setIsSynchronized (const ItemGroup &item_group)=0
	Indicates that the variable is synchronized on the group item_group.

Protected Member Functions
	Variable (const VariableBuildInfo &v, const VariableInfo &vi)
	Creates a variable linked to the reference v.
void	_setProperty (int property)
void	_setData (const Ref< IData > &data)
	Positions the data.
void	_setValidData (bool valid_data)
	Indicates if the variable data is valid.
bool	_hasValidData () const
	Indicates if the variable data is valid.
virtual void	_internalResize (const VariableResizeArgs &resize_args)=0
void	_checkSwapIsValid (Variable *rhs)
	Checks if it is possible to swap the values of the instance with those of rhs.
bool	_wantShrink () const
void	_resize (const VariableResizeArgs &resize_args)
virtual VariableComparerResults	_compareVariable (const VariableComparerArgs &compare_args)=0
	Comparison of values between variables.
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const

Private Member Functions
void	_checkSetItemFamily ()
void	_checkSetItemGroup ()
void	_checkSetProperty (VariableRef *)
bool	_hasReference () const
void	_removeMeshReference ()
VariableMetaData *	_createMetaData () const

Private Attributes
VariablePrivate *	m_p
	Implementation.

Friends
class	VariablePrivate

Additional Inherited Members
Public Types inherited from Arcane::IVariable
enum	eDependType { DPT_PreviousTime , DPT_CurrentTime }
	Dependency Type. More...
enum	{ PNoDump = (1 << 0) , PNoNeedSync = (1 << 1) , PHasTrace = (1 << 2) , PSubDomainDepend = (1 << 3) , PSubDomainPrivate = (1 << 4) , PExecutionDepend = (1 << 5) , PPrivate = (1 << 6) , PTemporary = (1 << 7) , PNoRestore = (1 << 8) , PNoExchange = (1 << 9) , PPersistant = (1 << 10) , PNoReplicaSync = (1 << 11) , PInShMem = (1 << 12) , PDumpNull = (1 << 13) }
	Properties of a variable. More...
static Int64	incrementModifiedTime ()
	Increments the modification counter and returns its value before modification.
Static Public Attributes inherited from Arcane::IVariable
static const char *	TAG_POST_PROCESSING = "PostProcessing"
	Tag used to indicate if a variable will be post-processed.
static const char *	TAG_POST_PROCESSING_AT_THIS_ITERATION = "PostProcessingAtThisIteration"
	Tag used to indicate if a variable will be post-processed at this iteration.

Detailed Description

Instance of a variable.

This class manages the data of a variable. This instance should generally not be used by code developers.

Todo: explain better

A variable is characterized by:

its name,
its type: real, integer, tensor, ...,
its kind: scalar, array, nodal quantity, cell-center quantity ...

A variable based on a type of mesh entity is called a mesh variable.

The variable is generally used by a module (IModule) via a reference (VariableRef).

Variables are persistent and their reading/writing is done by the read() and write() methods.

Warning: This class is entirely managed by Arcane, and modules that use it should generally only use it to retrieve information. Operations that modify this instance (such as setItemGroup()) should only be used if the developer has a good understanding of their functioning.

This class must not be copied.

Definition at line 74 of file Variable.h.

Constructor & Destructor Documentation

◆ Variable()

Arcane::Variable::Variable	(	const VariableBuildInfo &	v,
		const VariableInfo &	vi )

protected

Creates a variable linked to the reference v.

Definition at line 343 of file Variable.cc.

References m_p, Arcane::TraceAccessor::TraceAccessor(), and Arcane::TraceAccessor::traceMng().

Referenced by _checkSwapIsValid(), Arcane::Array2VariableT< T >::Array2VariableT(), operator=(), Variable(), Arcane::VariableArrayT< T >::VariableArrayT(), and Arcane::VariableScalarT< T >::VariableScalarT().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~Variable()

Arcane::Variable::~Variable ( )

override

Frees resources.

Definition at line 353 of file Variable.cc.

References m_p.

Member Function Documentation

◆ _checkSetItemFamily()

void Arcane::Variable::_checkSetItemFamily ( )

private

Definition at line 1050 of file Variable.cc.

◆ _checkSetItemGroup()

void Arcane::Variable::_checkSetItemGroup ( )

private

Definition at line 1100 of file Variable.cc.

◆ _checkSetProperty()

void Arcane::Variable::_checkSetProperty ( VariableRef * ref )

private

Definition at line 440 of file Variable.cc.

◆ _checkSwapIsValid()

void Arcane::Variable::_checkSwapIsValid ( Variable * rhs )

protected

Checks if it is possible to swap the values of the instance with those of rhs.

Since this method is called by a derived class, we are sure that rhs is the same C++ type as the instance and therefore there is no need to check, for example, that the dimensions or the data type are the same. For the swap to be valid, the mesh, the family and the group must be the same. To do this, it is sufficient to check that the group is the same.

Definition at line 1394 of file Variable.cc.

References ARCANE_FATAL, isPartial(), itemGroup(), Arcane::VariablePrivate::m_is_used, m_p, and Variable().

Here is the call graph for this function:

◆ _compareVariable()

virtual VariableComparerResults Arcane::Variable::_compareVariable ( const VariableComparerArgs & compare_args )

protectedpure virtual

Comparison of values between variables.

Referenced by checkIfSame(), checkIfSameOnAllReplica(), and checkIfSync().

Here is the caller graph for this function:

◆ _createMetaData()

VariableMetaData * Arcane::Variable::_createMetaData ( ) const

private

Definition at line 753 of file Variable.cc.

◆ _hasReference()

bool Arcane::Variable::_hasReference ( ) const

private

Definition at line 364 of file Variable.cc.

◆ _hasValidData()

bool Arcane::Variable::_hasValidData ( ) const

protected

Indicates if the variable data is valid.

The data is valid at the end of a call to setUsed().

Definition at line 941 of file Variable.cc.

References m_p.

◆ _internalApi()

IVariableInternal * Arcane::Variable::_internalApi ( )

overridevirtual

max_print	maximum number of messages to display. If 0, no element is displayed. If positive, display at most max_print elements. If negative, all elements are displayed.
compare_ghost	if true, compares values both on owned entities and ghost entities. Otherwise, it only compares on owned entities.

group_name	group. It must correspond to an existing group of the variable's type (e.g., CellGroup for a cell variable).
value	initialization value. The string must be convertible to the variable's type.

true	in case of error or if the variable is not a mesh variable.
false	if the initialization is successful.

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Variable()

◆ ~Variable()

Member Function Documentation

◆ _checkSetItemFamily()

◆ _checkSetItemGroup()

◆ _checkSetProperty()

◆ _checkSwapIsValid()

◆ _compareVariable()

◆ _createMetaData()

◆ _hasReference()

◆ _hasValidData()

◆ _internalApi()

◆ _removeMeshReference()

◆ _resize()

◆ _setData()

◆ _setProperty()

◆ _setValidData()

◆ _wantShrink()

◆ addDepend() [1/2]

◆ addDepend() [2/2]

◆ addTag()

◆ addVariableRef()

◆ allocationInfo()

◆ changeGroupIds()

◆ checkIfSame()

◆ checkIfSameOnAllReplica()

◆ checkIfSync()

◆ computeFunction()

◆ createMetaData()

◆ createMetaDataRef()

◆ dataFactoryMng()

◆ dataType()

◆ dependInfos()

◆ dimension()

◆ firstReference()

◆ fullName()

◆ hasTag()

◆ initialize()

◆ isPartial()

◆ isUsed()

◆ itemFamily()

◆ itemFamilyName()

◆ itemGroup()

◆ itemGroupName()

◆ itemKind()

◆ memoryAccessTrace()

◆ mesh()

◆ meshHandle()

◆ meshName()

◆ modifiedTime()

◆ multiTag()

◆ name()

◆ nbReference()

◆ notifyBeginWrite()

◆ notifyEndRead()

◆ notifyReferencePropertyChanged()

◆ onSizeChangedObservable()

◆ property()

◆ read()

◆ readObservable()

◆ removeDepend()

◆ removeTag()

◆ removeVariableRef()

◆ resize()

◆ resizeFromGroup()

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ setAllocationInfo()

◆ setComputeFunction()

◆ setTraceInfo()

◆ setUpToDate()

◆ setUsed()