Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::IItemFamilyNetwork Class Referenceabstract

Public Types

enum  eSchedulingOrder { TopologicalOrder , InverseTopologicalOrder , Unknown }
typedef std::function< void(IItemFamily *)> IItemFamilyNetworkTask

Public Member Functions

virtual bool isActivated () const =0
virtual void addDependency (IItemFamily *master_family, IItemFamily *slave_family, IIncrementalItemConnectivity *slave_to_master_connectivity, bool is_deep_connectivity=true)=0
 Adds a dependency between two families; an element of master_family is composed of elements of slave_family. The memory responsibility for master_to_slave_connectivity is handled by ItemFamilyNetwork.
virtual void addRelation (IItemFamily *source_family, IItemFamily *target_family, IIncrementalItemConnectivity *source_to_target_connectivity)=0
 Adds a relation between two families; an element of source_family is connected to one or more elements of target_family The memory responsibility for source_to_target_connectivity is handled by ItemFamilyNetwork.
virtual IIncrementalItemConnectivitygetDependency (IItemFamily *source_family, IItemFamily *target_family)=0
 Returns the dependency connectivity between the families source_family.
virtual IIncrementalItemConnectivitygetRelation (IItemFamily *source_family, IItemFamily *target_family)=0
virtual IIncrementalItemConnectivitygetConnectivity (IItemFamily *source_family, IItemFamily *target_family, const String &name)=0
 Returns the connectivity between the families source_family and.
virtual IIncrementalItemConnectivitygetConnectivity (IItemFamily *source_family, IItemFamily *target_family, const String &name, bool &is_dependency)=0
virtual IIncrementalItemConnectivitygetStoredConnectivity (IItemFamily *source_family, IItemFamily *target_family, const String &name)=0
 Returns, if associated with storage, the connectivity between the families source_family and target_family named name, whether it is a relation or a dependency.
virtual IIncrementalItemConnectivitygetStoredConnectivity (IItemFamily *source_family, IItemFamily *target_family, const String &name, bool &is_dependency)=0
virtual List< IIncrementalItemConnectivity * > getConnectivities ()=0
 Get the list of all connectivities, whether they are relations or dependencies.
virtual SharedArray< IIncrementalItemConnectivity * > getChildConnectivities (IItemFamily *source_family)=0
 Get the list of all connectivities (dependencies or relations), children of a.
virtual SharedArray< IIncrementalItemConnectivity * > getParentConnectivities (IItemFamily *target_family)=0
virtual SharedArray< IIncrementalItemConnectivity * > getChildDependencies (IItemFamily *source_family)=0
 Get the list of all dependencies, children of a family source_family or.
virtual SharedArray< IIncrementalItemConnectivity * > getParentDependencies (IItemFamily *target_family)=0
virtual SharedArray< IIncrementalItemConnectivity * > getChildRelations (IItemFamily *source_family)=0
 Get the list of all relations, children of a family source_family or parents.
virtual SharedArray< IIncrementalItemConnectivity * > getParentRelations (IItemFamily *source_family)=0
virtual const std::set< IItemFamily * > & getFamilies () const =0
 Get the list of all families.
virtual SharedArray< IItemFamily * > getFamilies (eSchedulingOrder order) const =0
virtual void schedule (IItemFamilyNetworkTask task, eSchedulingOrder order=TopologicalOrder)=0
 Schedules the execution of a task, in topological or inverse topological order.
virtual void setIsStored (IIncrementalItemConnectivity *connectivity)=0
 Marks a connectivity as stored.
virtual bool isStored (IIncrementalItemConnectivity *connectivity)=0
 Retrieves information regarding the storage of the connectivity.
virtual bool isDeep (IIncrementalItemConnectivity *connectivity)=0
 Retrieves information regarding the storage of the connectivity.
virtual Integer registerConnectedGraph (IGraph2 *graph)=0
 Registers a graph managing DOFs connected to the mesh.
virtual void releaseConnectedGraph (Integer graph_id)=0
 Deregisters a graph managing DOFs connected to the mesh.
virtual void removeConnectedDoFsFromCells (Int32ConstArrayView local_ids)=0
 Removes DOFs and links between DOFs connected to deleted cells.

Static Public Attributes

static constexpr bool plug_serializer = true

Detailed Description

Definition at line 33 of file IItemFamilyNetwork.h.

Member Typedef Documentation

◆ IItemFamilyNetworkTask

typedef std::function<void(IItemFamily*)> Arcane::IItemFamilyNetwork::IItemFamilyNetworkTask

Definition at line 41 of file IItemFamilyNetwork.h.

Member Enumeration Documentation

◆ eSchedulingOrder

enum Arcane::IItemFamilyNetwork::eSchedulingOrder

Definition at line 45 of file IItemFamilyNetwork.h.

Member Data Documentation

◆ plug_serializer

bool Arcane::IItemFamilyNetwork::plug_serializer = true
staticconstexpr

Definition at line 55 of file IItemFamilyNetwork.h.


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