scoping:from mesh
Last update: 31.07.2026Version: 0.0.0
Description
Provides the entire mesh scoping based on the requested location
Inputs
This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.
| Pin number | Name | Status | Expected type(s) |
|---|---|---|---|
| 0 | mesh | Required | abstract_meshed_region |
| 1 | requested_location | string |
mesh (Pin 0)
- Required: Yes
- Expected type(s):
abstract_meshed_region
requested_location (Pin 1)
- Required: No
- Expected type(s):
string
if nothing the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental
Outputs
This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.
| Pin number | Name | Expected type(s) |
|---|---|---|
| 0 | scoping | scoping |
scoping (Pin 0)
- Expected type(s):
scoping
Configurations
This operator supports configuration options that modify its behavior.
mutex
- Expected type(s):
bool - Default value: false
If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.
Scripting
This operator can be accessed through scripting interfaces using these identifiers.
Category: scoping
Plugin: core
Scripting name: from_mesh
Full name: scoping.from_mesh
Internal name: MeshScopingProvider
License: None
Examples
These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.
C++
#include "dpf_api.h"
ansys::dpf::Operator op("MeshScopingProvider"); // operator instantiation
op.connect(0, my_mesh);
op.connect(1, my_requested_location);
ansys::dpf::Scoping my_scoping = op.getOutput<ansys::dpf::Scoping>(0);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.scoping.from_mesh() # operator instantiation
op.inputs.mesh.connect(my_mesh)
op.inputs.requested_location.connect(my_requested_location)
my_scoping = op.outputs.scoping()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.scoping.from_mesh() # operator instantiation
op.inputs.mesh.Connect(my_mesh)
op.inputs.requested_location.Connect(my_requested_location)
my_scoping = op.outputs.scoping.GetData()
Changelog
- Version 0.0.0: Initial release.