Common

class ansys.dpf.core.common.locations

Contains strings for scoping and field locations.

none = "none"

elemental = "Elemental"

data is one per element

elemental_nodal = "ElementalNodal"

one per node per element

nodal = "Nodal"

one per node

time_freq = "TimeFreq_sets"

one per time set

overall = "overall"

applies everywhere

time_freq_step = "TimeFreq_steps"

one per time step

faces = "Faces"

one per face

zone = "zone"

one per zone

elemental_and_faces = "ElementalAndFaces"

data available in elements and faces of the model

enum ansys.dpf.core.common.types(value)

The 'types' enum contains the available types passed through operators and workflows to DPF.

Valid values are as follows:

string = <types.string: 0>

int = <types.int: 1>

double = <types.double: 2>

bool = <types.bool: 3>

field = <types.field: 4>

collection = <types.collection: 5>

scoping = <types.scoping: 6>

data_sources = <types.data_sources: 7>

meshed_region = <types.meshed_region: 8>

time_freq_support = <types.time_freq_support: 9>

result_info = <types.result_info: 10>

cyclic_support = <types.cyclic_support: 11>

property_field = <types.property_field: 12>

workflow = <types.workflow: 13>

run = <types.run: 14>

any = <types.any: 15>

vec_int = <types.vec_int: 16>

vec_double = <types.vec_double: 17>

support = <types.support: 18>

operator = <types.operator: 19>

data_tree = <types.data_tree: 20>

vec_string = <types.vec_string: 21>

string_field = <types.string_field: 22>

custom_type_field = <types.custom_type_field: 23>

generic_data_container = <types.generic_data_container: 24>

mesh_info = <types.mesh_info: 25>

fields_container = <types.fields_container: -1>

scopings_container = <types.scopings_container: -2>

meshes_container = <types.meshes_container: -3>

streams_container = <types.streams_container: -4>

bytes = <types.bytes: -5>

enum ansys.dpf.core.common.natures(value)

The 'natures' enum contains the dimensionality types. It can be used to create a field of a given dimensionality.

Valid values are as follows:

scalar = <natures.scalar: 0>

vector = <natures.vector: 1>

matrix = <natures.matrix: 2>

symmatrix = <natures.symmatrix: 5>

enum ansys.dpf.core.common.shell_layers(value)

The 'shell_layers' enum contains the available order of shell layers (or lack of shell layers) that defines how the field’s data is ordered.

Valid values are as follows:

notset = <shell_layers.notset: -1>

top = <shell_layers.top: 0>

bottom = <shell_layers.bottom: 1>

topbottom = <shell_layers.topbottom: 2>

mid = <shell_layers.mid: 3>

topbottommid = <shell_layers.topbottommid: 4>

nonelayer = <shell_layers.nonelayer: 5>

layerindependent = <shell_layers.layerindependent: 6>

class ansys.dpf.core.common.elemental_properties

Contains strings to define elemental property fields.

element_shape = "elshape"

element shape property data is provided

element_type = "eltype"

element type property data is provided

connectivity = "connectivity"

connectivity property data is provided

material = "mat"

material property data is provided

element_properties = "elprops"

element properties data is provided

apdl_element_type = "apdl_element_type"

apdl element type property data is provided

elements_faces_connectivity = "elements_faces_connectivity"

element faces connectivity property data is provided

class ansys.dpf.core.common.nodal_properties

Contains strings to define nodal property fields.

coordinates = "coordinates"

coordinates data is provided

nodal_connectivity = "reverse_connectivity"

nodal connectivity property data is provided

class ansys.dpf.core.common.face_properties

Contains strings to define face property fields.

faces_type = "faces_type"

face type property data is provided

faces_nodes_connectivity = "faces_nodes_connectivity"

faces connectivity property data is provided

class ansys.dpf.core.common.config_options

Contains strings to define configuration options.

num_thread = "num_threads"

number of threads

use_cache = "use_cache"

usage of cache if a server with gRPC communication protocol is used.

class ansys.dpf.core.common.DefinitionLabels

Contains Python definition labels.

class ansys.dpf.core.common.SubClassSmartDict

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, default is returned if given, otherwise KeyError is raised

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values