DPF C++ Client Library 2024 R2

ansys::dpf::ScopingsContainer Class Reference

Last update: 16.07.2025

#include <dpf_api.h>

Inherits ansys::dpf::CollectionBase.

Public Member Functions

 ScopingsContainer (ScopingsContainer const &)
 
 ScopingsContainer (ScopingsContainer &&) noexcept
 
 ScopingsContainer (Client const *const client)
 
 ScopingsContainer (Client const *const client, std::vector< std::string > const &labels)
 
 ScopingsContainer (int id, Client const *const client)
 
 ScopingsContainer (std::vector< std::string > const &labels)
 
ScopingsContainer & operator= (ScopingsContainer const &)
 
ScopingsContainer & operator= (ScopingsContainer &&) noexcept
 
Scoping operator[] (dp_int index)
 
Scoping at (dp_index index)
 
const Scoping at (dp_index index) const
 
void update (Scoping &f, dp_index index)
 
void add (LabelSpace const &labels, Scoping const &f)
 
std::vector< Scoping > getScopings (LabelSpace const &labels) const
 
std::vector< dp_index > getScopingsIndices (LabelSpace const &lab_space) const
 
Scoping getScoping (LabelSpace const &labels) const
 
ScopingsContainer createSubScopingsContainer (LabelSpace const &lab_space) const
 
ScopingsContainer deep_copy (ansys::dpf::Client const *const client=nullptr) const
 

Static Public Member Functions

static ScopingsContainer emptyScopingsContainer ()
 

Detailed Description

Contains a group of scopings.

The scopings container is designed as a set of scopings ordered through labels and ids. Labels identify how the fields are filtered. The most common scopings container have the label "body" with ids corresponding to each body entity.

Generally, a defined ScopingsContainer will contain Scoping entities to apply on the MeshedRegion entities of a corresponding MeshesContainer.

See also
Scoping
Using collections and labels
Examples
AveragingTest.cpp, and WorkflowExamples.cpp.

Constructor & Destructor Documentation

◆ ScopingsContainer() [1/4]

ansys::dpf::ScopingsContainer::ScopingsContainer ( Client const *const  client)

Create a new scopings container on a server.

Parameters
[in]clientClient instance designating the IP, port and protocol to use.

◆ ScopingsContainer() [2/4]

ansys::dpf::ScopingsContainer::ScopingsContainer ( Client const *const  client,
std::vector< std::string > const &  labels 
)

Create a group of scopings with the given labels on a server.

Parameters
[in]clientClient instance designating the IP, port and protocol to use.
[in]labelsLabels for group of scopings.

◆ ScopingsContainer() [3/4]

ansys::dpf::ScopingsContainer::ScopingsContainer ( int  id,
Client const *const  client 
)

Retrieve an existing instance of ScopingsContainer on a server.

Parameters
[in]idId of the ScopingsContainer object on the server's database.
[in]clientClient instance designating the IP, port and protocol to use.

◆ ScopingsContainer() [4/4]

ansys::dpf::ScopingsContainer::ScopingsContainer ( std::vector< std::string > const &  labels)

Create a group of scopings with the given labels.

Parameters
[in]labelsLabels for group of scopings.

Member Function Documentation

◆ add()

void ansys::dpf::ScopingsContainer::add ( LabelSpace const &  labels,
Scoping const &  f 
)

Add new scoping with given labels to group.

Parameters
[in]labelsLabel space to use for new scoping.
[in]fScoping to add to group.

◆ at() [1/2]

Scoping ansys::dpf::ScopingsContainer::at ( dp_index  index)
Returns
Scoping at given index.
Parameters
[in]indexIndex of scoping to get.

◆ at() [2/2]

const Scoping ansys::dpf::ScopingsContainer::at ( dp_index  index) const
Returns
Scoping at given index.
Parameters
[in]indexIndex of scoping to get.

◆ createSubScopingsContainer()

ScopingsContainer ansys::dpf::ScopingsContainer::createSubScopingsContainer ( LabelSpace const &  lab_space) const

Create a new ScopingsContainer with all the scopings corresponding to the label space in input

Parameters
[in]lab_spaceLabel space for which to create new scopings container.

◆ deep_copy()

ScopingsContainer ansys::dpf::ScopingsContainer::deep_copy ( ansys::dpf::Client const *const  client = nullptr) const

Create a new ScopingsContainer on a server by copying all the data of this ScopingsContainer.

Parameters
[in]clientClient instance designating the IP, port and protocol to use.

◆ emptyScopingsContainer()

static ScopingsContainer ansys::dpf::ScopingsContainer::emptyScopingsContainer ( )
static

Create an empty scopings container.

Returns
Empty ScopingsContainer.

◆ getScoping()

Scoping ansys::dpf::ScopingsContainer::getScoping ( LabelSpace const &  labels) const
Returns
First scoping for given label space.
Parameters
[in]labelsLabel space for which to get first scoping.

◆ getScopings()

std::vector< Scoping > ansys::dpf::ScopingsContainer::getScopings ( LabelSpace const &  labels) const
Returns
Vector of scopings for given label space.
Parameters
[in]labelsLabel space for whict to get scopings.

◆ getScopingsIndices()

std::vector< dp_index > ansys::dpf::ScopingsContainer::getScopingsIndices ( LabelSpace const &  lab_space) const
Returns
Scoping indices for scopings given by LabelSpace
Parameters
[in]lab_spaceLabelSpace defining scopings for which to get indices.

◆ operator[]()

Scoping ansys::dpf::ScopingsContainer::operator[] ( dp_int  index)
Returns
Scoping at given index.
Parameters
[in]indexIndex of scoping.

◆ update()

void ansys::dpf::ScopingsContainer::update ( Scoping &  f,
dp_index  index 
)

Update Scoping at given index.

Parameters
[in]fNew scoping.
[in]indexIndex of scoping to update.

Connect with Ansys