Inheritance diagram for Arcane::VariableMng::InternalApi:

Collaboration diagram for Arcane::VariableMng::InternalApi:

Public Member Functions
	InternalApi (VariableMng *v)
void	build () override
	Constructs the instance members.
void	initialize () override
	Initializes the instance. The instance is not usable until this method has been called.
void	removeAllVariables () override
	Removes and destroys the variables managed by this manager.
void	removeAllShMemVariables () override
void	detachMeshVariables (IMesh *mesh) override
	Detaches variables associated with the mesh mesh.
void	addVariableRef (VariableRef *var) override
	Adds a reference to a variable.
void	removeVariableRef (VariableRef *var) override
	Removes a reference to a variable.
void	addVariable (IVariable *var) override
	Adds a variable.
void	removeVariable (IVariable *var) override
	Removes a variable.
void	initializeVariables (bool is_continue) override
	Initializes the variables.
ISubDomain *	internalSubDomain () const override
	Temporary internal function to retrieve the subdomain.
IAcceleratorMng *	acceleratorMng () const override
	Manager for accelerators.
void	setAcceleratorMng (Ref< IAcceleratorMng > v) override
	Sets the accelerator manager.
void	addAutoDestroyVariable (VariableRef *var) override
	Adds the variable to the list of variables that are kept until the end of execution.
Public Member Functions inherited from Arcane::IVariableMngInternal
virtual	~IVariableMngInternal ()=default
	Releases resources.

Private Attributes
VariableMng *	m_variable_mng = nullptr

Detailed Description

Definition at line 118 of file VariableMng.h.

Constructor & Destructor Documentation

◆ InternalApi()

Arcane::VariableMng::InternalApi::InternalApi ( VariableMng * v )

inlineexplicit

Definition at line 123 of file VariableMng.h.

Member Function Documentation

◆ acceleratorMng()

IAcceleratorMng * Arcane::VariableMng::InternalApi::acceleratorMng ( ) const

inlineoverridevirtual

Manager for accelerators.

Implements Arcane::IVariableMngInternal.

Definition at line 140 of file VariableMng.h.

◆ addAutoDestroyVariable()

void Arcane::VariableMng::InternalApi::addAutoDestroyVariable ( VariableRef * var )

inlineoverridevirtual

Adds the variable to the list of variables that are kept until the end of execution.

The variable will be destroyed by calling the operator delete() when calling IVariableMng::removeAllVariables().

Implements Arcane::IVariableMngInternal.

Definition at line 142 of file VariableMng.h.

◆ addVariable()

void Arcane::VariableMng::InternalApi::addVariable ( IVariable * var )

inlineoverridevirtual

Adds a variable.

Adds the variable var.

The variable validity is not checked (void checkVariable()).

Precondition: var != 0; var must not already be referenced.

Returns: the implementation associated with var.

Implements Arcane::IVariableMngInternal.

Definition at line 136 of file VariableMng.h.

◆ addVariableRef()

void Arcane::VariableMng::InternalApi::addVariableRef ( VariableRef * var )

inlineoverridevirtual

Adds a reference to a variable.

Adds the reference var to the manager.

Precondition: var != 0; var must not already be referenced.

Returns: the implementation associated with var.

Implements Arcane::IVariableMngInternal.

Definition at line 134 of file VariableMng.h.

◆ build()

void Arcane::VariableMng::InternalApi::build ( )

inlineoverridevirtual

Constructs the instance members.

The instance is not usable until this method has been called. This method must be called before initialize().

Warning: This method must only be called once.

Implements Arcane::IVariableMngInternal.

Definition at line 129 of file VariableMng.h.

◆ detachMeshVariables()

void Arcane::VariableMng::InternalApi::detachMeshVariables ( IMesh * mesh )

inlineoverridevirtual

Detaches variables associated with the mesh mesh.

Implements Arcane::IVariableMngInternal.

Definition at line 133 of file VariableMng.h.

◆ initialize()

void Arcane::VariableMng::InternalApi::initialize ( )

inlineoverridevirtual

Initializes the instance. The instance is not usable until this method has been called.

Warning: This method must only be called once.

Implements Arcane::IVariableMngInternal.

Definition at line 130 of file VariableMng.h.

◆ initializeVariables()

void Arcane::VariableMng::InternalApi::initializeVariables ( bool is_continue )

inlineoverridevirtual

Initializes the variables.

Iterates through the list of variables and initializes them. Only variables from a used module are initialized.

Parameters

is_continue true if resuming.

Implements Arcane::IVariableMngInternal.

Definition at line 138 of file VariableMng.h.

◆ internalSubDomain()

ISubDomain * Arcane::VariableMng::InternalApi::internalSubDomain ( ) const

inlineoverridevirtual

Temporary internal function to retrieve the subdomain.

Implements Arcane::IVariableMngInternal.

Definition at line 139 of file VariableMng.h.

◆ removeAllShMemVariables()

void Arcane::VariableMng::InternalApi::removeAllShMemVariables ( )

inlineoverridevirtual

Removes and destroys variables having the PInShMem property, managed by this manager.

Implements Arcane::IVariableMngInternal.

Definition at line 132 of file VariableMng.h.

◆ removeAllVariables()

void Arcane::VariableMng::InternalApi::removeAllVariables ( )

inlineoverridevirtual

Removes and destroys the variables managed by this manager.

Implements Arcane::IVariableMngInternal.

Definition at line 131 of file VariableMng.h.

◆ removeVariable()

void Arcane::VariableMng::InternalApi::removeVariable ( IVariable * var )

inlineoverridevirtual

Removes a variable.

Removes the variable var.

After calling this method, the variable must no longer be used.

Precondition: var != 0; var must have a single reference.

Implements Arcane::IVariableMngInternal.

Definition at line 137 of file VariableMng.h.

◆ removeVariableRef()

void Arcane::VariableMng::InternalApi::removeVariableRef ( VariableRef * var )

inlineoverridevirtual

Removes a reference to a variable.

Removes the reference var from the manager.

If var is not referenced by the manager, nothing is done.

Precondition: var != 0

Implements Arcane::IVariableMngInternal.

Definition at line 135 of file VariableMng.h.

◆ setAcceleratorMng()

void Arcane::VariableMng::InternalApi::setAcceleratorMng ( Ref< IAcceleratorMng > v )

inlineoverridevirtual

Sets the accelerator manager.

Implements Arcane::IVariableMngInternal.

Definition at line 141 of file VariableMng.h.

Member Data Documentation

◆ m_variable_mng

VariableMng* Arcane::VariableMng::InternalApi::m_variable_mng = nullptr

private

Definition at line 146 of file VariableMng.h.

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

VariableMng.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InternalApi()

Member Function Documentation

◆ acceleratorMng()

◆ addAutoDestroyVariable()

◆ addVariable()

◆ addVariableRef()

◆ build()

◆ detachMeshVariables()

◆ initialize()

◆ initializeVariables()

◆ internalSubDomain()

◆ removeAllShMemVariables()

◆ removeAllVariables()

◆ removeVariable()

◆ removeVariableRef()

◆ setAcceleratorMng()

Member Data Documentation

◆ m_variable_mng