diff --git a/doc/source/_static/dpf_operators.html b/doc/source/_static/dpf_operators.html index d9cf9e841a7..000f81ba888 100644 --- a/doc/source/_static/dpf_operators.html +++ b/doc/source/_static/dpf_operators.html @@ -2070,7 +2070,7 @@

Configurating operators

0 0 0 0 0 0 0 0 0 -">

Example of workflows and their scripts

math: imaginary part

Inputs

Outputs

Configurations

Scripting

math: amplitude (fields container)

Inputs

Outputs

Configurations

Scripting

metadata: mesh support provider

Inputs

Outputs

Configurations

Scripting

result: beam axial stress (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: unit convert (fields container)

Inputs

Outputs

Configurations

Scripting

result: element orientations X

Inputs

Outputs

Configurations

Scripting

math: norm (fields container)

Inputs

Outputs

Configurations

Scripting

mapping: prepare mapping workflow

Inputs

Outputs

Configurations

Scripting

math: sqrt (fields container)

Inputs

Outputs

Configurations

Scripting

math: conjugate

Inputs

Outputs

Configurations

Scripting

utility: html doc

Inputs

Outputs

Configurations

Scripting

math: real part

Inputs

Outputs

Configurations

Scripting

result: current density

Inputs

Outputs

Configurations

Scripting

math: multiply (complex fields)

Inputs

Outputs

Configurations

Scripting

utility: merge result infos

Inputs

Outputs

Configurations

Scripting

result: cyclic kinetic energy

Inputs

Outputs

Configurations

Scripting

result: global total mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: unit convert

Inputs

Outputs

Configurations

Scripting

math: norm (field)

Inputs

Outputs

Configurations

Scripting

utility: make label space

Inputs

Outputs

Configurations

Scripting

math: sqrt (field)

Inputs

Outputs

Configurations

Scripting

math: accumulate min over label

Inputs

Outputs

Configurations

Scripting

result: y plus (y+)

Inputs

Outputs

Configurations

Scripting

math: +

Inputs

Outputs

Configurations

Scripting

server: grpc shutdown server

Inputs

Outputs

Configurations

Scripting

result: magnetic scalar potential

Inputs

Outputs

Configurations

Scripting

min_max: min max over time

Inputs

Outputs

Configurations

Scripting

math: time freq interpolation

Inputs

Outputs

Configurations

Scripting

math: + (fields container)

Inputs

Outputs

Configurations

Scripting

math: sin (fields container)

Inputs

Outputs

Configurations

Scripting

result: tangential contact force

Inputs

Outputs

Configurations

Scripting

math: + constant (field)

Inputs

Outputs

Configurations

Scripting

math: / (component-wise field)

Inputs

Outputs

Configurations

Scripting

result: normal contact force

Inputs

Outputs

Configurations

Scripting

math: + constant (fields container)

Inputs

Outputs

Configurations

Scripting

math: cross product (fields container)

Inputs

Outputs

Configurations

Scripting

result: cyclic strain energy

Inputs

Outputs

Configurations

Scripting

invariant: scalar invariants (fields container)

Inputs

Outputs

Configurations

Scripting

mapping: find reduced coordinates

Inputs

Outputs

Configurations

Scripting

scoping: rescope property field

Inputs

Outputs

Configurations

Scripting

result: plastic strain principal 1

Inputs

Outputs

Configurations

Scripting

math: -

Inputs

Outputs

Configurations

Scripting

math: total sum

Inputs

Outputs

Configurations

Scripting

math: - (fields container)

Inputs

Outputs

Configurations

Scripting

scoping: intersect scopings

Inputs

Outputs

Configurations

Scripting

math: ^ (field)

Inputs

Outputs

Configurations

Scripting

scoping: elements in mesh

Inputs

Outputs

Configurations

Scripting

math: scale (field)

Inputs

Outputs

Configurations

Scripting

result: enthalpy

Inputs

Outputs

Configurations

Scripting

math: ^ (fields container)

Inputs

Outputs

Configurations

Scripting

result: global eroded internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: scale fields container

Inputs

Outputs

Configurations

Scripting

math: sweeping phase

Inputs

Outputs

Configurations

Scripting

math: centroid

Inputs

Outputs

Configurations

Scripting

math: sweeping phase (fields container)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (field)

Inputs

Outputs

Configurations

Scripting

math: centroid (fields container)

Inputs

Outputs

Configurations

Scripting

math: ^2 (field)

Inputs

Outputs

Configurations

Scripting

utility: remove unnecessary labels

Inputs

Outputs

Configurations

Scripting

result: velocity Z

Inputs

Outputs

Configurations

Scripting

result: reaction force Z

Inputs

Outputs

Configurations

Scripting

math: sin (field)

Inputs

Outputs

Configurations

Scripting

math: cos (field)

Inputs

Outputs

Configurations

Scripting

math: cos (fields container)

Inputs

Outputs

Configurations

Scripting

logic: ascending sort

Inputs

Outputs

Configurations

Scripting

result: initial coordinates (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: convert to fields container

Inputs

Outputs

Configurations

Scripting

math: linear combination

Inputs

Outputs

Configurations

Scripting

math: ^2 (fields container)

Inputs

Outputs

Configurations

Scripting

result: mean static pressure

Inputs

Outputs

Configurations

Scripting

math: exp (field)

Inputs

Outputs

Configurations

Scripting

math: exp (fields container)

Inputs

Outputs

Configurations

Scripting

math: * (component-wise field)

Inputs

Outputs

Configurations

Scripting

result: stress max_shear

Inputs

Outputs

Configurations

Scripting

result: euler nodes

Inputs

Outputs

Configurations

Scripting

math: * (component-wise field) (fields container)

Inputs

Outputs

Configurations

Scripting

result: beam TR shear stress (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: num surface status changes

Inputs

Outputs

Configurations

Scripting

math: ln (field)

Inputs

Outputs

Configurations

Scripting

mesh: mesh to pyvista

Inputs

Outputs

Configurations

Scripting

math: ln (fields container)

Inputs

Outputs

Configurations

Scripting

invariant: scalar invariants (field)

Inputs

Outputs

Configurations

Scripting

math: cross product

Inputs

Outputs

Configurations

Scripting

filter: high pass (timefreq)

Inputs

Outputs

Configurations

Scripting

math: / (component-wise fields container)

Inputs

Outputs

Configurations

Scripting

result: global sliding interface energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: kronecker product

Inputs

Outputs

Configurations

Scripting

math: modulus (fields container)

Inputs

Outputs

Configurations

Scripting

result: joint relative angular velocity

Inputs

Outputs

Configurations

Scripting

math: dot (complex fields)

Inputs

Outputs

Configurations

Scripting

result: gasket stress XZ

Inputs

Outputs

Configurations

Scripting

math: / (complex fields)

Inputs

Outputs

Configurations

Scripting

utility: unitary field

Inputs

Outputs

Configurations

Scripting

utility: server path

Inputs

Outputs

Configurations

Scripting

result: beam axial force (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: derivate (complex fields)

Inputs

Outputs

Configurations

Scripting

math: polar to complex fields

Inputs

Outputs

Configurations

Scripting

utility: merge data tree

Inputs

Outputs

Configurations

Scripting

math: dot (fields container)

Inputs

Outputs

Configurations

Scripting

result: nodal moment

Inputs

Outputs

Configurations

Scripting

math: phase (field)

Inputs

Outputs

Configurations

Scripting

math: phase (fields container)

Inputs

Outputs

Configurations

Scripting

math: modulus (field)

Inputs

Outputs

Configurations

Scripting

result: elemental mass

Inputs

Outputs

Configurations

Scripting

result: heat flux

Inputs

Outputs

Configurations

Scripting

math: total sum (fields container)

Inputs

Outputs

Configurations

Scripting

result: co-energy

Inputs

Outputs

Configurations

Scripting

math: dot

Inputs

Outputs

Configurations

Scripting

math: outer product

Inputs

Outputs

Configurations

Scripting

math: overall dot

Inputs

Outputs

Configurations

Scripting

math: relative error

Inputs

Outputs

Configurations

Scripting

result: velocity Y

Inputs

Outputs

Configurations

Scripting

result: reaction force Y

Inputs

Outputs

Configurations

Scripting

result: global velocity (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: superficial velocity

Inputs

Outputs

Configurations

Scripting

math: absolute value by component (field)

Inputs

Outputs

Configurations

Scripting

result: incremental energy

Inputs

Outputs

Configurations

Scripting

result: thermal strain

Inputs

Outputs

Configurations

Scripting

result: stiffness matrix energy

Inputs

Outputs

Configurations

Scripting

math: absolute value by component (fields container)

Inputs

Outputs

Configurations

Scripting

result: total temperature

Inputs

Outputs

Configurations

Scripting

result: cyclic equivalent mass

Inputs

Outputs

Configurations

Scripting

result: acceleration Y

Inputs

Outputs

Configurations

Scripting

utility: delegate to operator

Inputs

Outputs

Configurations

Scripting

logic: component selector (fields container)

Inputs

Outputs

Configurations

Scripting

logic: component selector (field)

Inputs

Outputs

Configurations

Scripting

scoping: on property

Inputs

Outputs

Configurations

Scripting

result: stress intensity

Inputs

Outputs

Configurations

Scripting

logic: component transformer (field)

Inputs

Outputs

Configurations

Scripting

min_max: over field

Inputs

Outputs

Configurations

Scripting

result: transient rayleigh integration

Inputs

Outputs

Configurations

Scripting

logic: component transformer (fields container)

Inputs

Outputs

Configurations

Scripting

logic: same property fields?

Inputs

Outputs

Configurations

Scripting

logic: elementary data selector (fields container)

Inputs

Outputs

Configurations

Scripting

utility: convert to scoping

Inputs

Outputs

Configurations

Scripting

logic: elementary data selector (field)

Inputs

Outputs

Configurations

Scripting

utility: change location

Inputs

Outputs

Configurations

Scripting

utility: extract field

Inputs

Outputs

Configurations

Scripting

mesh: node coordinates

Inputs

Outputs

Configurations

Scripting

mesh: stl export

Inputs

Outputs

Configurations

Scripting

utility: bind support

Inputs

Outputs

Configurations

Scripting

utility: convert to meshes container

Inputs

Outputs

Configurations

Scripting

result: beam torsional moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: equivalent stress parameter

Inputs

Outputs

Configurations

Scripting

utility: convert to field

Inputs

Outputs

Configurations

Scripting

result: beam axial total strain (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: set property

Inputs

Outputs

Configurations

Scripting

utility: forward field

Inputs

Outputs

Configurations

Scripting

utility: forward fields container

Inputs

Outputs

Configurations

Scripting

result: electric flux density

Inputs

Outputs

Configurations

Scripting

geo: integrate over elements

Inputs

Outputs

Configurations

Scripting

result: plastic strain principal 2

Inputs

Outputs

Configurations

Scripting

utility: forward meshes container

Inputs

Outputs

Configurations

Scripting

result: compute total strain X

Example of workflows and their scripts

math: imaginary part

Inputs

Outputs

Configurations

Scripting

math: amplitude (fields container)

Inputs

Outputs

Configurations

Scripting

metadata: mesh support provider

Inputs

Outputs

Configurations

Scripting

result: beam axial stress (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: unit convert (fields container)

Inputs

Outputs

Configurations

Scripting

result: element orientations X

Inputs

Outputs

Configurations

Scripting

math: norm (fields container)

Inputs

Outputs

Configurations

Scripting

mapping: prepare mapping workflow

Inputs

Outputs

Configurations

Scripting

math: sqrt (fields container)

Inputs

Outputs

Configurations

Scripting

math: conjugate

Inputs

Outputs

Configurations

Scripting

utility: html doc

Inputs

Outputs

Configurations

Scripting

math: real part

Inputs

Outputs

Configurations

Scripting

result: current density

Inputs

Outputs

Configurations

Scripting

math: multiply (complex fields)

Inputs

Outputs

Configurations

Scripting

utility: merge result infos

Inputs

Outputs

Configurations

Scripting

result: cyclic kinetic energy

Inputs

Outputs

Configurations

Scripting

result: global total mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: unit convert

Inputs

Outputs

Configurations

Scripting

math: norm (field)

Inputs

Outputs

Configurations

Scripting

utility: make label space

Inputs

Outputs

Configurations

Scripting

math: sqrt (field)

Inputs

Outputs

Configurations

Scripting

result: y plus (y+)

Inputs

Outputs

Configurations

Scripting

math: accumulate min over label

Inputs

Outputs

Configurations

Scripting

math: +

Inputs

Outputs

Configurations

Scripting

server: grpc shutdown server

Inputs

Outputs

Configurations

Scripting

result: magnetic scalar potential

Inputs

Outputs

Configurations

Scripting

min_max: min max over time

Inputs

Outputs

Configurations

Scripting

math: time freq interpolation

Inputs

Outputs

Configurations

Scripting

math: + (fields container)

Inputs

Outputs

Configurations

Scripting

math: sin (fields container)

Inputs

Outputs

Configurations

Scripting

result: tangential contact force

Inputs

Outputs

Configurations

Scripting

math: + constant (field)

Inputs

Outputs

Configurations

Scripting

math: / (component-wise field)

Inputs

Outputs

Configurations

Scripting

result: normal contact force

Inputs

Outputs

Configurations

Scripting

math: + constant (fields container)

Inputs

Outputs

Configurations

Scripting

math: cross product (fields container)

Inputs

Outputs

Configurations

Scripting

result: cyclic strain energy

Inputs

Outputs

Configurations

Scripting

invariant: scalar invariants (fields container)

Inputs

Outputs

Configurations

Scripting

mapping: find reduced coordinates

Inputs

Outputs

Configurations

Scripting

scoping: rescope property field

Inputs

Outputs

Configurations

Scripting

result: plastic strain principal 1

Inputs

Outputs

Configurations

Scripting

math: -

Inputs

Outputs

Configurations

Scripting

math: total sum

Inputs

Outputs

Configurations

Scripting

math: - (fields container)

Inputs

Outputs

Configurations

Scripting

scoping: intersect scopings

Inputs

Outputs

Configurations

Scripting

math: ^ (field)

Inputs

Outputs

Configurations

Scripting

scoping: elements in mesh

Inputs

Outputs

Configurations

Scripting

math: scale (field)

Inputs

Outputs

Configurations

Scripting

result: enthalpy

Inputs

Outputs

Configurations

Scripting

math: ^ (fields container)

Inputs

Outputs

Configurations

Scripting

result: global eroded internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: scale fields container

Inputs

Outputs

Configurations

Scripting

math: sweeping phase

Inputs

Outputs

Configurations

Scripting

math: centroid

Inputs

Outputs

Configurations

Scripting

math: sweeping phase (fields container)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (field)

Inputs

Outputs

Configurations

Scripting

math: centroid (fields container)

Inputs

Outputs

Configurations

Scripting

math: ^2 (field)

Inputs

Outputs

Configurations

Scripting

utility: remove unnecessary labels

Inputs

Outputs

Configurations

Scripting

result: velocity Z

Inputs

Outputs

Configurations

Scripting

result: reaction force Z

Inputs

Outputs

Configurations

Scripting

math: sin (field)

Inputs

Outputs

Configurations

Scripting

math: cos (field)

Inputs

Outputs

Configurations

Scripting

math: cos (fields container)

Inputs

Outputs

Configurations

Scripting

logic: ascending sort

Inputs

Outputs

Configurations

Scripting

result: initial coordinates (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: convert to fields container

Inputs

Outputs

Configurations

Scripting

math: linear combination

Inputs

Outputs

Configurations

Scripting

math: ^2 (fields container)

Inputs

Outputs

Configurations

Scripting

result: mean static pressure

Inputs

Outputs

Configurations

Scripting

math: exp (field)

Inputs

Outputs

Configurations

Scripting

math: exp (fields container)

Inputs

Outputs

Configurations

Scripting

math: * (component-wise field)

Inputs

Outputs

Configurations

Scripting

result: stress max_shear

Inputs

Outputs

Configurations

Scripting

result: euler nodes

Inputs

Outputs

Configurations

Scripting

math: * (component-wise field) (fields container)

Inputs

Outputs

Configurations

Scripting

result: beam TR shear stress (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: num surface status changes

Inputs

Outputs

Configurations

Scripting

math: ln (field)

Inputs

Outputs

Configurations

Scripting

mesh: mesh to pyvista

Inputs

Outputs

Configurations

Scripting

math: ln (fields container)

Inputs

Outputs

Configurations

Scripting

invariant: scalar invariants (field)

Inputs

Outputs

Configurations

Scripting

math: cross product

Inputs

Outputs

Configurations

Scripting

filter: high pass (timefreq)

Inputs

Outputs

Configurations

Scripting

math: / (component-wise fields container)

Inputs

Outputs

Configurations

Scripting

result: global sliding interface energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: kronecker product

Inputs

Outputs

Configurations

Scripting

math: modulus (fields container)

Inputs

Outputs

Configurations

Scripting

result: joint relative angular velocity

Inputs

Outputs

Configurations

Scripting

math: dot (complex fields)

Inputs

Outputs

Configurations

Scripting

result: gasket stress XZ

Inputs

Outputs

Configurations

Scripting

math: / (complex fields)

Inputs

Outputs

Configurations

Scripting

utility: unitary field

Inputs

Outputs

Configurations

Scripting

utility: server path

Inputs

Outputs

Configurations

Scripting

result: beam axial force (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: derivate (complex fields)

Inputs

Outputs

Configurations

Scripting

math: polar to complex fields

Inputs

Outputs

Configurations

Scripting

utility: merge data tree

Inputs

Outputs

Configurations

Scripting

math: dot (fields container)

Inputs

Outputs

Configurations

Scripting

result: nodal moment

Inputs

Outputs

Configurations

Scripting

math: phase (field)

Inputs

Outputs

Configurations

Scripting

math: phase (fields container)

Inputs

Outputs

Configurations

Scripting

math: modulus (field)

Inputs

Outputs

Configurations

Scripting

result: elemental mass

Inputs

Outputs

Configurations

Scripting

result: heat flux

Inputs

Outputs

Configurations

Scripting

math: total sum (fields container)

Inputs

Outputs

Configurations

Scripting

result: co-energy

Inputs

Outputs

Configurations

Scripting

math: dot

Inputs

Outputs

Configurations

Scripting

math: outer product

Inputs

Outputs

Configurations

Scripting

math: overall dot

Inputs

Outputs

Configurations

Scripting

math: relative error

Inputs

Outputs

Configurations

Scripting

result: velocity Y

Inputs

Outputs

Configurations

Scripting

result: reaction force Y

Inputs

Outputs

Configurations

Scripting

result: global velocity (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: superficial velocity

Inputs

Outputs

Configurations

Scripting

math: absolute value by component (field)

Inputs

Outputs

Configurations

Scripting

result: incremental energy

Inputs

Outputs

Configurations

Scripting

result: thermal strain

Inputs

Outputs

Configurations

Scripting

result: stiffness matrix energy

Inputs

Outputs

Configurations

Scripting

math: absolute value by component (fields container)

Inputs

Outputs

Configurations

Scripting

metadata: element types provider

Inputs

Outputs

Configurations

Scripting

result: total temperature

Inputs

Outputs

Configurations

Scripting

result: cyclic equivalent mass

Inputs

Outputs

Configurations

Scripting

result: acceleration Y

Inputs

Outputs

Configurations

Scripting

utility: delegate to operator

Inputs

Outputs

Configurations

Scripting

logic: component selector (fields container)

Inputs

Outputs

Configurations

Scripting

logic: component selector (field)

Inputs

Outputs

Configurations

Scripting

scoping: on property

Inputs

Outputs

Configurations

Scripting

result: stress intensity

Inputs

Outputs

Configurations

Scripting

logic: component transformer (field)

Inputs

Outputs

Configurations

Scripting

logic: component transformer (fields container)

Inputs

Outputs

Configurations

Scripting

logic: same property fields?

Inputs

Outputs

Configurations

Scripting

logic: elementary data selector (fields container)

Inputs

Outputs

Configurations

Scripting

utility: convert to scoping

Inputs

Outputs

Configurations

Scripting

logic: elementary data selector (field)

Inputs

Outputs

Configurations

Scripting

utility: change location

Inputs

Outputs

Configurations

Scripting

utility: extract field

Inputs

Outputs

Configurations

Scripting

mesh: node coordinates

Inputs

Outputs

Configurations

Scripting

mesh: stl export

Inputs

Outputs

Configurations

Scripting

utility: bind support

Inputs

Outputs

Configurations

Scripting

utility: convert to meshes container

Inputs

Outputs

Configurations

Scripting

result: beam torsional moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: equivalent stress parameter

Inputs

Outputs

Configurations

Scripting

utility: convert to field

Inputs

Outputs

Configurations

Scripting

result: beam axial total strain (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: set property

Inputs

Outputs

Configurations

Scripting

result: electric flux density Y

Inputs

Outputs

Configurations

Scripting

utility: forward field

Inputs

Outputs

Configurations

Scripting

utility: forward fields container

Inputs

Outputs

Configurations

Scripting

result: electric flux density

Inputs

Outputs

Configurations

Scripting

geo: integrate over elements

Inputs

Outputs

Configurations

Scripting

result: plastic strain principal 2

Inputs

Outputs

Configurations

Scripting

utility: forward meshes container

Inputs

Outputs

Configurations

Scripting

result: compute total strain X

Configurating operators Get the XX normal component (00 component).">

Inputs

Outputs

Configurations

Scripting

utility: forward

Inputs

Outputs

Configurations

Scripting

utility: incremental meshes container

Inputs

Outputs

Configurations

Scripting

utility: txt file to dpf

Inputs

Outputs

Configurations

Scripting

utility: bind support (fields container)

Inputs

Outputs

Configurations

Scripting

result: normal contact moment

Inputs

Outputs

Configurations

Scripting

utility: fields container get attribute

Inputs

Outputs

Configurations

Scripting

result: thermal strain XZ

Inputs

Outputs

Configurations

Scripting

utility: assemble scalars to vector

Inputs

Outputs

Configurations

Scripting

result: global eroded hourglass energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: assemble scalars to vector fc

Inputs

Outputs

Configurations

Scripting

utility: assemble scalars to matrix

Inputs

Outputs

Configurations

Scripting

math: make one on component

Inputs

Outputs

Configurations

Scripting

mesh: from scopings

Inputs

Outputs

Configurations

Scripting

utility: assemble scalars to matrix fc

Inputs

Outputs

Configurations

Scripting

result: interface contact area (LSDyna)

Inputs

Outputs

Configurations

Scripting

mesh: extract from field

Inputs

Outputs

Configurations

Scripting

result: pres to field

Inputs

Outputs

Configurations

Scripting

result: part internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: part momentum (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: compute invariant terms rbd

Inputs

Outputs

Configurations

Scripting

utility: default value

Inputs

Outputs

Configurations

Scripting

averaging: elemental nodal to nodal elemental (fields container)

Inputs

Outputs

Configurations

Scripting

result: rms velocity

Inputs

Outputs

Configurations

Scripting

result: acceleration X

Inputs

Outputs

Configurations

Scripting

result: poynting vector

Inputs

Outputs

Configurations

Scripting

utility: extract sub fields container

Inputs

Outputs

Configurations

Scripting

result: total strain (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: extract sub meshes container

Inputs

Outputs

Configurations

Scripting

utility: extract sub scopings container

Inputs

Outputs

Configurations

Scripting

averaging: elemental difference (fields container)

Inputs

Outputs

Configurations

Scripting

utility: compute time scoping

Inputs

Outputs

Configurations

Scripting

result: static pressure

Inputs

Outputs

Configurations

Scripting

result: elastic strain

Inputs

Outputs

Configurations

Scripting

math: window bartlett (fields container)

Inputs

Outputs

Configurations

Scripting

result: turbulent viscosity

Inputs

Outputs

Configurations

Scripting

utility: python generator

Inputs

Outputs

Configurations

Scripting

utility: make overall

Inputs

Outputs

Configurations

Scripting

geo: elements volume

Inputs

Outputs

Configurations

Scripting

result: pressure

Inputs

Outputs

Configurations

Scripting

result: stress

Inputs

Outputs

Configurations

Scripting

result: stress X

Inputs

Outputs

Configurations

Scripting

result: gasket thermal closure XZ

Inputs

Outputs

Configurations

Scripting

result: stress Y

Inputs

Outputs

Configurations

Scripting

result: stress Z

Inputs

Outputs

Configurations

Scripting

result: gasket thermal closure XY

Inputs

Outputs

Configurations

Scripting

result: stress XY

Inputs

Outputs

Configurations

Scripting

compression: kMeans clustering

Inputs

Outputs

Configurations

Scripting

result: stress YZ

Inputs

Outputs

Configurations

Scripting

result: stress XZ

Inputs

Outputs

Configurations

Scripting

utility: merge string fields

Inputs

Outputs

Configurations

Scripting

result: stress principal 1

Inputs

Outputs

Configurations

Scripting

result: stress principal 2

Inputs

Outputs

Configurations

Scripting

result: tangential contact moment

Inputs

Outputs

Configurations

Scripting

invariant: convertnum bcs to nod

Inputs

Outputs

Configurations

Scripting

result: stress principal 3

Inputs

Outputs

Configurations

Scripting

result: stress von mises

Inputs

Outputs

Configurations

Scripting

result: gasket stress

Inputs

Outputs

Configurations

Scripting

result: contact fluid penetration pressure

Inputs

Outputs

Configurations

Scripting

result: gasket stress X

Inputs

Outputs

Configurations

Scripting

result: gasket stress XY

Inputs

Outputs

Configurations

Scripting

result: gasket deformation

Inputs

Outputs

Configurations

Scripting

result: gasket deformation X

Inputs

Outputs

Configurations

Scripting

geo: elements facets surfaces over time

Inputs

Outputs

Configurations

Scripting

result: gasket deformation XY

Inputs

Outputs

Configurations

Scripting

metadata: property field provider by property name

Inputs

Outputs

Configurations

Scripting

result: gasket deformation XZ

Inputs

Outputs

Configurations

Scripting

mesh: mesh provider

Inputs

Outputs

Configurations

Scripting

result: gasket inelastic closure

Inputs

Outputs

Configurations

Scripting

result: gasket inelastic closure X

Inputs

Outputs

Configurations

Scripting

result: write cms rbd file

Inputs

Outputs

Configurations

Scripting

serialization: export symbolic workflow

Inputs

Outputs

Configurations

Scripting

result: gasket inelastic closure XY

Inputs

Outputs

Configurations

Scripting

result: plastic strain eqv

Inputs

Outputs

Configurations

Scripting

mesh: beam properties

Inputs

Outputs

Configurations

Scripting

result: gasket inelastic closure XZ

Inputs

Outputs

Configurations

Scripting

result: gasket thermal closure

Inputs

Outputs

Configurations

Scripting

result: gasket thermal closure X

Inputs

Outputs

Configurations

Scripting

result: elastic strain X

Inputs

Outputs

Configurations

Scripting

result: elastic strain Y

Inputs

Outputs

Configurations

Scripting

result: elastic strain Z

Inputs

Outputs

Configurations

Scripting

math: min/max over time

Inputs

Outputs

Configurations

Scripting

utility: merge fields containers

Inputs

Outputs

Configurations

Scripting

result: global energy ratio without eroded energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: merge weighted fields containers

Inputs

Outputs

Configurations

Scripting

result: elastic strain XY

Inputs

Outputs

Configurations

Scripting

result: elastic strain YZ

Inputs

Outputs

Configurations

Scripting

result: interface contact mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

invariant: eigen values (fields container)

Inputs

Outputs

Configurations

Scripting

result: elastic strain XZ

Inputs

Outputs

Configurations

Scripting

metadata: mesh property provider

Inputs

Outputs

Configurations

Scripting

result: rigid transformation

Inputs

Outputs

Configurations

Scripting

result: elastic strain principal 1

Inputs

Outputs

Configurations

Scripting

result: elastic strain principal 2

Inputs

Outputs

Configurations

Scripting

utility: merge scopings

Inputs

Outputs

Configurations

Scripting

result: elastic strain principal 3

Inputs

Outputs

Configurations

Scripting

result: cyclic analytic disp max

Inputs

Outputs

Configurations

Scripting

result: elastic strain eqv

Inputs

Outputs

Configurations

Scripting

result: transform invariant terms rbd

Inputs

Outputs

Configurations

Scripting

result: elastic strain intensity

Inputs

Outputs

Configurations

Scripting

result: elastic strain max_shear

Inputs

Outputs

Configurations

Scripting

result: turbulent dissipation rate (omega)

Inputs

Outputs

Configurations

Scripting

averaging: to elemental (fields container)

Inputs

Outputs

Configurations

Scripting

result: plastic strain

Inputs

Outputs

Configurations

Scripting

scoping: transpose

Inputs

Outputs

Configurations

Scripting

result: mass fraction

Inputs

Outputs

Configurations

Scripting

result: plastic strain X

Inputs

Outputs

Configurations

Scripting

result: coordinates (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: plastic strain Y

Inputs

Outputs

Configurations

Scripting

filter: band pass (fields container)

Inputs

Outputs

Configurations

Scripting

geo: to polar coordinates

Inputs

Outputs

Configurations

Scripting

math: fft evaluation

Inputs

Outputs

Configurations

Scripting

result: global total energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: plastic strain Z

Inputs

Outputs

Configurations

Scripting

utility: merge materials

Inputs

Outputs

Configurations

Scripting

serialization: vtk export

Inputs

Outputs

Configurations

Scripting

result: dynamic viscosity

Inputs

Outputs

Configurations

Scripting

result: plastic strain XY

Inputs

Outputs

Configurations

Scripting

result: hydrostatic pressure

Inputs

Outputs

Configurations

Scripting

result: compute stress von mises

Inputs

Outputs

Configurations

Scripting

filter: low pass (scoping)

Inputs

Outputs

Configurations

Scripting

mesh: iso surfaces

Inputs

Outputs

Configurations

Scripting

result: plastic strain YZ

Inputs

Outputs

Configurations

Scripting

result: plastic strain XZ

Inputs

Outputs

Configurations

Scripting

result: workflow energy per harmonic

Inputs

Outputs

Configurations

Scripting

result: plastic strain principal 3

Inputs

Outputs

Configurations

Scripting

result: plastic strain intensity

Inputs

Outputs

Configurations

Scripting

result: plastic strain max_shear

Inputs

Outputs

Configurations

Scripting

filter: low pass (timefreq)

Inputs

Outputs

Configurations

Scripting

filter: band pass (field)

Inputs

Outputs

Configurations

Scripting

result: thermal strain X

Inputs

Outputs

Configurations

Scripting

result: thermal strain Y

Inputs

Outputs

Configurations

Scripting

math: accumulate level over label

Inputs

Outputs

Configurations

Scripting

result: equivalent radiated power

Inputs

Outputs

Configurations

Scripting

result: thermal strain Z

Inputs

Outputs

Configurations

Scripting

result: thermal strain XY

Inputs

Outputs

Configurations

Scripting

math: accumulate over label

Inputs

Outputs

Configurations

Scripting

utility: merge scopings containers

Inputs

Outputs

Configurations

Scripting

result: thermal strain YZ

Inputs

Outputs

Configurations

Scripting

result: thermal strain principal 1

Inputs

Outputs

Configurations

Scripting

result: thermal strain principal 2

Inputs

Outputs

Configurations

Scripting

result: thermal strain principal 3

Inputs

Outputs

Configurations

Scripting

result: wall shear stress

Inputs

Outputs

Configurations

Scripting

result: velocity

Inputs

Outputs

Configurations

Scripting

result: reaction force

Inputs

Outputs

Configurations

Scripting

serialization: serializer

Inputs

Outputs

Configurations

Scripting

result: velocity X

Inputs

Outputs

Configurations

Scripting

result: reaction force X

Inputs

Outputs

Configurations

Scripting

geo: cartesian to spherical coordinates (fields container)

Inputs

Outputs

Configurations

Scripting

result: global external work (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: acceleration

Inputs

Outputs

Configurations

Scripting

result: element centroids

Inputs

Outputs

Configurations

Scripting

result: acceleration Z

Inputs

Outputs

Configurations

Scripting

scoping: rescope (fields container)

Inputs

Outputs

Configurations

Scripting

serialization: workflow to workflow_topology

Inputs

Outputs

Configurations

Scripting

result: displacement

Inputs

Outputs

Configurations

Scripting

result: displacement X

Inputs

Outputs

Configurations

Scripting

averaging: force_summation

Inputs

Outputs

Configurations

Scripting

result: displacement Y

Inputs

Outputs

Configurations

Scripting

result: displacement Z

Inputs

Outputs

Configurations

Scripting

result: heat flux X

Inputs

Outputs

Configurations

Scripting

result: heat flux Y

Inputs

Outputs

Configurations

Scripting

result: electric field

Inputs

Outputs

Configurations

Scripting

result: total contact moment

Inputs

Outputs

Configurations

Scripting

result: heat flux Z

Inputs

Outputs

Configurations

Scripting

serialization: serialize to hdf5

Inputs

Outputs

Configurations

Scripting

result: element orientations

Inputs

Outputs

Configurations

Scripting

result: element orientations Y

Inputs

Outputs

Configurations

Scripting

mesh: split mesh wrt property

Inputs

Outputs

Configurations

Scripting

result: element orientations Z

Inputs

Outputs

Configurations

Scripting

result: element nodal forces

Inputs

Outputs

Configurations

Scripting

result: compute total strain Z

Outputs

Configurations

Scripting

result: gasket inelastic closure

Inputs

Outputs

Configurations

Scripting

result: gasket inelastic closure X

Inputs

Outputs

Configurations

Scripting

result: write cms rbd file

Inputs

Outputs

Configurations

Scripting

serialization: export symbolic workflow

Inputs

Outputs

Configurations

Scripting

result: gasket inelastic closure XY

Inputs

Outputs

Configurations

Scripting

result: plastic strain eqv

Inputs

Outputs

Configurations

Scripting

mesh: beam properties

Inputs

Outputs

Configurations

Scripting

result: gasket inelastic closure XZ

Inputs

Outputs

Configurations

Scripting

result: gasket thermal closure

Inputs

Outputs

Configurations

Scripting

result: gasket thermal closure X

Inputs

Outputs

Configurations

Scripting

result: elastic strain X

Inputs

Outputs

Configurations

Scripting

result: elastic strain Y

Inputs

Outputs

Configurations

Scripting

result: elastic strain Z

Inputs

Outputs

Configurations

Scripting

math: min/max over time

Inputs

Outputs

Configurations

Scripting

utility: merge fields containers

Inputs

Outputs

Configurations

Scripting

result: global energy ratio without eroded energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: merge weighted fields containers

Inputs

Outputs

Configurations

Scripting

result: elastic strain XY

Inputs

Outputs

Configurations

Scripting

result: elastic strain YZ

Inputs

Outputs

Configurations

Scripting

result: interface contact mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

invariant: eigen values (fields container)

Inputs

Outputs

Configurations

Scripting

result: elastic strain XZ

Inputs

Outputs

Configurations

Scripting

metadata: mesh property provider

Inputs

Outputs

Configurations

Scripting

result: rigid transformation

Inputs

Outputs

Configurations

Scripting

result: elastic strain principal 1

Inputs

Outputs

Configurations

Scripting

result: elastic strain principal 2

Inputs

Outputs

Configurations

Scripting

utility: merge scopings

Inputs

Outputs

Configurations

Scripting

result: elastic strain principal 3

Inputs

Outputs

Configurations

Scripting

result: cyclic analytic disp max

Inputs

Outputs

Configurations

Scripting

result: elastic strain eqv

Inputs

Outputs

Configurations

Scripting

result: electric flux density X

Inputs

Outputs

Configurations

Scripting

result: transform invariant terms rbd

Inputs

Outputs

Configurations

Scripting

result: elastic strain intensity

Inputs

Outputs

Configurations

Scripting

result: elastic strain max_shear

Inputs

Outputs

Configurations

Scripting

result: turbulent dissipation rate (omega)

Inputs

Outputs

Configurations

Scripting

averaging: to elemental (fields container)

Inputs

Outputs

Configurations

Scripting

result: plastic strain

Inputs

Outputs

Configurations

Scripting

scoping: transpose

Inputs

Outputs

Configurations

Scripting

result: mass fraction

Inputs

Outputs

Configurations

Scripting

result: plastic strain X

Inputs

Outputs

Configurations

Scripting

result: coordinates (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: plastic strain Y

Inputs

Outputs

Configurations

Scripting

filter: band pass (fields container)

Inputs

Outputs

Configurations

Scripting

geo: to polar coordinates

Inputs

Outputs

Configurations

Scripting

math: fft evaluation

Inputs

Outputs

Configurations

Scripting

result: global total energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: plastic strain Z

Inputs

Outputs

Configurations

Scripting

utility: merge materials

Inputs

Outputs

Configurations

Scripting

serialization: vtk export

Inputs

Outputs

Configurations

Scripting

result: dynamic viscosity

Inputs

Outputs

Configurations

Scripting

result: plastic strain XY

Inputs

Outputs

Configurations

Scripting

result: hydrostatic pressure

Inputs

Outputs

Configurations

Scripting

result: compute stress von mises

Inputs

Outputs

Configurations

Scripting

filter: low pass (scoping)

Inputs

Outputs

Configurations

Scripting

mesh: iso surfaces

Inputs

Outputs

Configurations

Scripting

result: plastic strain YZ

Inputs

Outputs

Configurations

Scripting

result: plastic strain XZ

Inputs

Outputs

Configurations

Scripting

result: workflow energy per harmonic

Inputs

Outputs

Configurations

Scripting

result: plastic strain principal 3

Inputs

Outputs

Configurations

Scripting

result: plastic strain intensity

Inputs

Outputs

Configurations

Scripting

result: plastic strain max_shear

Inputs

Outputs

Configurations

Scripting

filter: low pass (timefreq)

Inputs

Outputs

Configurations

Scripting

filter: band pass (field)

Inputs

Outputs

Configurations

Scripting

result: thermal strain X

Inputs

Outputs

Configurations

Scripting

result: thermal strain Y

Inputs

Outputs

Configurations

Scripting

result: equivalent radiated power

Inputs

Outputs

Configurations

Scripting

result: thermal strain Z

Inputs

Outputs

Configurations

Scripting

utility: merge scopings containers

Inputs

Outputs

Configurations

Scripting

math: accumulate over label

Inputs

Outputs

Configurations

Scripting

result: thermal strain XY

Inputs

Outputs

Configurations

Scripting

result: thermal strain YZ

Inputs

Outputs

Configurations

Scripting

result: thermal strain principal 1

Inputs

Outputs

Configurations

Scripting

result: thermal strain principal 2

Inputs

Outputs

Configurations

Scripting

result: thermal strain principal 3

Inputs

Outputs

Configurations

Scripting

serialization: serializer

Inputs

Outputs

Configurations

Scripting

result: wall shear stress

Inputs

Outputs

Configurations

Scripting

result: velocity

Inputs

Outputs

Configurations

Scripting

result: reaction force

Inputs

Outputs

Configurations

Scripting

result: velocity X

Inputs

Outputs

Configurations

Scripting

result: reaction force X

Inputs

Outputs

Configurations

Scripting

geo: cartesian to spherical coordinates (fields container)

Inputs

Outputs

Configurations

Scripting

result: global external work (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: acceleration

Inputs

Outputs

Configurations

Scripting

result: element centroids

Inputs

Outputs

Configurations

Scripting

result: acceleration Z

Inputs

Outputs

Configurations

Scripting

scoping: rescope (fields container)

Inputs

Outputs

Configurations

Scripting

serialization: workflow to workflow_topology

Inputs

Outputs

Configurations

Scripting

result: displacement

Inputs

Outputs

Configurations

Scripting

result: electric field Z

Inputs

Outputs

Configurations

Scripting

result: displacement X

Inputs

Outputs

Configurations

Scripting

averaging: force_summation

Inputs

Outputs

Configurations

Scripting

result: displacement Y

Inputs

Outputs

Configurations

Scripting

result: electric field X

Inputs

Outputs

Configurations

Scripting

result: displacement Z

Inputs

Outputs

Configurations

Scripting

result: heat flux X

Inputs

Outputs

Configurations

Scripting

result: heat flux Y

Inputs

Outputs

Configurations

Scripting

result: electric field

Inputs

Outputs

Configurations

Scripting

result: total contact moment

Inputs

Outputs

Configurations

Scripting

result: heat flux Z

Inputs

Outputs

Configurations

Scripting

serialization: serialize to hdf5

Inputs

Outputs

Configurations

Scripting

result: element orientations

Inputs

Outputs

Configurations

Scripting

result: element orientations Y

Inputs

Outputs

Configurations

Scripting

result: magnetic field Z

Inputs

Outputs

Configurations

Scripting

averaging: elemental mean (fields container)

Inputs

Outputs

Configurations

Scripting

result: magnetic field Y

Inputs

Outputs

Configurations

Scripting

mesh: split mesh wrt property

Inputs

Outputs

Configurations

Scripting

result: element orientations Z

Inputs

Outputs

Configurations

Scripting

result: temperature gradient

Inputs

Outputs

Configurations

Scripting

result: cgns result provider

Inputs

Outputs

Configurations

Scripting

result: temperature gradient X

Inputs

Outputs

Configurations

Scripting

result: entropy

Inputs

Outputs

Configurations

Scripting

result: volume fraction

Inputs

Outputs

Configurations

Scripting

result: temperature gradient Y

Inputs

Outputs

Configurations

Scripting

result: temperature gradient Z

Inputs

Outputs

Configurations

Scripting

result: elemental summable miscellaneous data

Inputs

Outputs

Configurations

Scripting

result: magnetic field

Inputs

Outputs

Configurations

Scripting

result: compute stress Z

Inputs

Outputs

Configurations

Scripting

result: part eroded kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: magnetic field X

Inputs

Outputs

Configurations

Scripting

serialization: string deserializer

Inputs

Outputs

Configurations

Scripting

utility: merge meshes containers

Inputs

Outputs

Configurations

Scripting

result: magnetic flux density

Inputs

Outputs

Configurations

Scripting

result: magnetic flux density X

Inputs

Outputs

Configurations

Scripting

result: magnetic flux density Y

Inputs

Outputs

Configurations

Scripting

result: nodal force

Inputs

Outputs

Configurations

Scripting

result: magnetic flux density Z

Inputs

Outputs

Configurations

Scripting

result: electric field Y

Inputs

Outputs

Configurations

Scripting

result: electric flux density Z

Inputs

Outputs

Configurations

Scripting

result: element nodal forces

Inputs

Outputs

Configurations

Scripting

result: compute total strain Z

Configurating operators Only linear analysis are supported without On Demand Expansion. All coordinates are global coordinates. Euler Angles need to be included in the database. - Get the ZZ normal component (22 component).">

Inputs

Outputs

Configurations

Scripting

result: structural temperature

Inputs

Outputs

Configurations

Scripting

metadata: result info provider

Inputs

Outputs

Configurations

Scripting

mesh: skin (tri mesh)

Inputs

Outputs

Configurations

Scripting

result: stress ratio

Inputs

Outputs

Configurations

Scripting

filter: band pass (timescoping)

Inputs

Outputs

Configurations

Scripting

compression: sketch matrix

Inputs

Outputs

Configurations

Scripting

result: accu eqv plastic strain

Inputs

Outputs

Configurations

Scripting

result: plastic state variable

Inputs

Outputs

Configurations

Scripting

math: average over label

Inputs

Outputs

Configurations

Scripting

result: accu eqv creep strain

Inputs

Outputs

Configurations

Scripting

result: plastic strain energy density

Inputs

Outputs

Configurations

Scripting

result: material property of element

Inputs

Outputs

Configurations

Scripting

result: creep strain energy density

Inputs

Outputs

Configurations

Scripting

result: erp radiation efficiency

Inputs

Outputs

Configurations

Scripting

result: elastic strain energy density

Inputs

Outputs

Configurations

Scripting

result: contact status

Inputs

Outputs

Configurations

Scripting

serialization: field to csv

Inputs

Outputs

Configurations

Scripting

result: contact penetration

Inputs

Outputs

Configurations

Scripting

result: contact pressure

Inputs

Outputs

Configurations

Scripting

result: contact friction stress

Inputs

Outputs

Configurations

Scripting

result: contact total stress

Inputs

Outputs

Configurations

Scripting

result: contact sliding distance

Inputs

Outputs

Configurations

Scripting

utility: merge generic data container

Inputs

Outputs

Configurations

Scripting

result: global joint internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded element nodal forces

Inputs

Outputs

Configurations

Scripting

serialization: vtk to fields

Inputs

Outputs

Configurations

Scripting

result: contact gap distance

Inputs

Outputs

Configurations

Scripting

utility: merge any objects

Inputs

Outputs

Configurations

Scripting

result: contact surface heat flux

Inputs

Outputs

Configurations

Scripting

result: elemental volume

Inputs

Outputs

Configurations

Scripting

result: artificial hourglass energy

Inputs

Outputs

Configurations

Scripting

result: kinetic energy

Inputs

Outputs

Configurations

Scripting

result: thermal dissipation energy

Inputs

Outputs

Configurations

Scripting

result: nodal force

Inputs

Outputs

Configurations

Scripting

result: total mass

Inputs

Outputs

Configurations

Scripting

result: rms static pressure

Inputs

Outputs

Configurations

Scripting

result: swelling strains

Inputs

Outputs

Configurations

Scripting

result: total contact force

Inputs

Outputs

Configurations

Scripting

result: temperature

Inputs

Outputs

Configurations

Scripting

result: compute stress

Inputs

Outputs

Configurations

Scripting

result: raw displacement

Inputs

Outputs

Configurations

Scripting

result: raw reaction force

Inputs

Outputs

Configurations

Scripting

result: turbulent kinetic energy (k)

Inputs

Outputs

Configurations

Scripting

result: electric potential

Inputs

Outputs

Configurations

Scripting

result: thickness

Inputs

Outputs

Configurations

Scripting

result: mapdl run

Inputs

Outputs

Configurations

Scripting

result: equivalent mass

Inputs

Outputs

Configurations

Scripting

result: custom result

Inputs

Outputs

Configurations

Scripting

result: elemental heat generation

Inputs

Outputs

Configurations

Scripting

result: temperature gradient

Inputs

Outputs

Configurations

Scripting

result: elemental summable miscellaneous data

Inputs

Outputs

Configurations

Scripting

result: magnetic field

Inputs

Outputs

Configurations

Scripting

utility: merge meshes containers

Inputs

Outputs

Configurations

Scripting

result: magnetic flux density

Inputs

Outputs

Configurations

Scripting

result: magnetic vector potential

Inputs

Outputs

Configurations

Scripting

result: joint force reaction

Inputs

Outputs

Configurations

Scripting

result: joint moment reaction

Inputs

Outputs

Configurations

Scripting

result: beam T shear force (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: joint relative displacement

Inputs

Outputs

Configurations

Scripting

result: joint relative rotation

Inputs

Outputs

Configurations

Scripting

result: joint relative velocity

Inputs

Outputs

Configurations

Scripting

result: joint relative acceleration

Inputs

Outputs

Configurations

Scripting

result: joint relative angular acceleration

Inputs

Outputs

Configurations

Scripting

result: global internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

serialization: txt to data tree

Inputs

Outputs

Configurations

Scripting

result: thermal strains eqv

Inputs

Outputs

Configurations

Scripting

result: elemental non summable miscellaneous data

Inputs

Outputs

Configurations

Scripting

utility: merge supports

Inputs

Outputs

Configurations

Scripting

result: global kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: matrix inverse

Inputs

Outputs

Configurations

Scripting

result: global time step (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global rigid body stopper energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

geo: cartesian to spherical coordinates

Inputs

Outputs

Configurations

Scripting

result: global spring and damper energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam T bending moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global hourglass energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global system damping energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global eroded kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global energy ratio (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global added mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

mapping: on reduced coordinates

Inputs

Outputs

Configurations

Scripting

invariant: principal invariants (fields container)

Inputs

Outputs

Configurations

Scripting

result: global added mass (percentage) (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global center of mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam S shear force (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam S bending moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam RS shear stress (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: merge fields into field matrix

Inputs

Outputs

Configurations

Scripting

result: beam axial plastic strain (LSDyna)

Inputs

Outputs

Configurations

Scripting

invariant: von mises eqv (field)

Inputs

Outputs

Configurations

Scripting

invariant: segalman von mises eqv (field)

Inputs

Outputs

Configurations

Scripting

result: part eroded internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: part kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

scoping: on mesh property

Inputs

Outputs

Configurations

Scripting

serialization: string deserializer

Inputs

Outputs

Configurations

Scripting

result: compute stress Z

Inputs

Outputs

Configurations

Scripting

result: part eroded kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

scoping: from mesh

Inputs

Outputs

Configurations

Scripting

result: part added mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: part hourglass energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: part rigid body velocity (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: interface contact force (LSDyna)

Inputs

Outputs

Configurations

Scripting

min_max: time of max

Inputs

Outputs

Configurations

Scripting

scoping: nodes in mesh

Inputs

Outputs

Configurations

Scripting

metadata: cyclic support provider

Inputs

Outputs

Configurations

Scripting

result: interface resultant contact force (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: interface contact moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: density

Inputs

Outputs

Configurations

Scripting

result: spectrum data

Inputs

Outputs

Configurations

Scripting

averaging: elemental to elemental nodal (fields container)

Inputs

Outputs

Configurations

Scripting

result: total pressure

Inputs

Outputs

Configurations

Scripting

result: mean velocity

Inputs

Outputs

Configurations

Scripting

result: Lighthill tensor divergence

Inputs

Outputs

Configurations

Scripting

result: entropy

Inputs

Outputs

Configurations

Scripting

result: volume fraction

Inputs

Outputs

Configurations

Scripting

result: mass flow rate

Inputs

Outputs

Configurations

Scripting

result: mach number

Inputs

Outputs

Configurations

Scripting

result: rms temperature

Inputs

Outputs

Configurations

Scripting

scoping: scoping get attribute

Inputs

Outputs

Configurations

Scripting

result: read cms_rbd file

Inputs

Outputs

Configurations

Scripting

result: mean temperature

Inputs

Outputs

Configurations

Scripting

min_max: over fields container

Inputs

Outputs

Configurations

Scripting

result: surface heat rate

Inputs

Outputs

Configurations

Scripting

result: thermal conductivity

Inputs

Outputs

Configurations

Scripting

utility: extract scoping

Inputs

Outputs

Configurations

Scripting

result: specific heat

Inputs

Outputs

Configurations

Scripting

result: turbulent dissipation rate (epsilon)

Inputs

Outputs

Configurations

Scripting

metadata: time freq provider

Inputs

Outputs

Configurations

Scripting

metadata: mesh info provider

Inputs

Outputs

Configurations

Scripting

result: von mises stresses as mechanical

Inputs

Outputs

Configurations

Scripting

metadata: streams provider

Inputs

Outputs

Configurations

Scripting

result: poynting vector surface

Inputs

Outputs

Configurations

Scripting

metadata: datasources provider

Inputs

Outputs

Configurations

Scripting

scoping: rescope

Inputs

Outputs

Configurations

Scripting

filter: low pass (timescoping)

Inputs

Outputs

Configurations

Scripting

utility: data sources get attribute

Inputs

Outputs

Configurations

Scripting

mesh: meshes provider

Inputs

Outputs

Configurations

Scripting

metadata: mesh selection manager provider

Inputs

Outputs

Configurations

Scripting

utility: for each

Inputs

Outputs

Configurations

Scripting

metadata: boundary condition provider

Inputs

Outputs

Configurations

Scripting

utility: merge property fields

Inputs

Outputs

Configurations

Scripting

metadata: cyclic analysis?

Inputs

Outputs

Configurations

Scripting

metadata: material support provider

Inputs

Outputs

Configurations

Scripting

scoping: on named selection

Inputs

Outputs

Configurations

Scripting

scoping: reduce sampling scoping

Inputs

Outputs

Configurations

Scripting

math: accumulation per scoping

Inputs

Outputs

Configurations

Scripting

result: coordinate system

Inputs

Outputs

Configurations

Scripting

logic: splitter::streams

Inputs

Outputs

Configurations

Scripting

serialization: hdf5dpf custom read

Inputs

Outputs

Configurations

Scripting

result: nodal_to_global

Inputs

Outputs

Configurations

Scripting

scoping: rescope custom type field

Inputs

Outputs

Configurations

Scripting

result: global_to_nodal

Inputs

Outputs

Configurations

Scripting

min_max: min max by entity over time

Inputs

Outputs

Configurations

Scripting

result: rigid transformation provider

Inputs

Outputs

Configurations

Scripting

min_max: max over time

Inputs

Outputs

Configurations

Scripting

scoping: connectivity ids

Inputs

Outputs

Configurations

Scripting

utility: remote workflow instantiate

Inputs

Outputs

Configurations

Scripting

utility: remote operator instantiate

Inputs

Outputs

Configurations

Scripting

math: compute residual and error

Inputs

Outputs

Configurations

Scripting

result: structural temperature

Inputs

Outputs

Configurations

Scripting

metadata: result info provider

Inputs

Outputs

Configurations

Scripting

mesh: skin (tri mesh)

Inputs

Outputs

Configurations

Scripting

result: stress ratio

Inputs

Outputs

Configurations

Scripting

filter: band pass (timescoping)

Inputs

Outputs

Configurations

Scripting

compression: sketch matrix

Inputs

Outputs

Configurations

Scripting

result: accu eqv plastic strain

Inputs

Outputs

Configurations

Scripting

result: plastic state variable

Inputs

Outputs

Configurations

Scripting

result: accu eqv creep strain

Inputs

Outputs

Configurations

Scripting

result: plastic strain energy density

Inputs

Outputs

Configurations

Scripting

result: material property of element

Inputs

Outputs

Configurations

Scripting

result: creep strain energy density

Inputs

Outputs

Configurations

Scripting

result: erp radiation efficiency

Inputs

Outputs

Configurations

Scripting

result: elastic strain energy density

Inputs

Outputs

Configurations

Scripting

result: contact status

Inputs

Outputs

Configurations

Scripting

serialization: field to csv

Inputs

Outputs

Configurations

Scripting

result: contact penetration

Inputs

Outputs

Configurations

Scripting

result: contact pressure

Inputs

Outputs

Configurations

Scripting

result: contact friction stress

Inputs

Outputs

Configurations

Scripting

result: contact total stress

Inputs

Outputs

Configurations

Scripting

result: contact sliding distance

Inputs

Outputs

Configurations

Scripting

utility: merge generic data container

Inputs

Outputs

Configurations

Scripting

result: global joint internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded element nodal forces

Inputs

Outputs

Configurations

Scripting

serialization: vtk to fields

Inputs

Outputs

Configurations

Scripting

result: contact gap distance

Inputs

Outputs

Configurations

Scripting

utility: merge any objects

Inputs

Outputs

Configurations

Scripting

result: contact surface heat flux

Inputs

Outputs

Configurations

Scripting

result: elemental volume

Inputs

Outputs

Configurations

Scripting

result: artificial hourglass energy

Inputs

Outputs

Configurations

Scripting

result: kinetic energy

Inputs

Outputs

Configurations

Scripting

result: thermal dissipation energy

Inputs

Outputs

Configurations

Scripting

result: total mass

Inputs

Outputs

Configurations

Scripting

result: rms static pressure

Inputs

Outputs

Configurations

Scripting

result: swelling strains

Inputs

Outputs

Configurations

Scripting

result: total contact force

Inputs

Outputs

Configurations

Scripting

result: temperature

Inputs

Outputs

Configurations

Scripting

result: compute stress

Inputs

Outputs

Configurations

Scripting

result: raw displacement

Inputs

Outputs

Configurations

Scripting

result: raw reaction force

Inputs

Outputs

Configurations

Scripting

result: turbulent kinetic energy (k)

Inputs

Outputs

Configurations

Scripting

result: electric potential

Inputs

Outputs

Configurations

Scripting

result: thickness

Inputs

Outputs

Configurations

Scripting

result: mapdl run

Inputs

Outputs

Configurations

Scripting

result: equivalent mass

Inputs

Outputs

Configurations

Scripting

result: custom result

Inputs

Outputs

Configurations

Scripting

result: elemental heat generation

Inputs

Outputs

Configurations

Scripting

result: magnetic vector potential

Inputs

Outputs

Configurations

Scripting

result: joint force reaction

Inputs

Outputs

Configurations

Scripting

result: joint moment reaction

Inputs

Outputs

Configurations

Scripting

result: beam T shear force (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: joint relative displacement

Inputs

Outputs

Configurations

Scripting

result: joint relative rotation

Inputs

Outputs

Configurations

Scripting

result: joint relative velocity

Inputs

Outputs

Configurations

Scripting

result: joint relative acceleration

Inputs

Outputs

Configurations

Scripting

result: joint relative angular acceleration

Inputs

Outputs

Configurations

Scripting

result: global internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

serialization: txt to data tree

Inputs

Outputs

Configurations

Scripting

result: thermal strains eqv

Inputs

Outputs

Configurations

Scripting

result: elemental non summable miscellaneous data

Inputs

Outputs

Configurations

Scripting

utility: merge supports

Inputs

Outputs

Configurations

Scripting

result: global kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

math: matrix inverse

Inputs

Outputs

Configurations

Scripting

result: global time step (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global rigid body stopper energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

geo: cartesian to spherical coordinates

Inputs

Outputs

Configurations

Scripting

result: global spring and damper energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam T bending moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global hourglass energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global system damping energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global eroded kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global energy ratio (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global added mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

mapping: on reduced coordinates

Inputs

Outputs

Configurations

Scripting

invariant: principal invariants (fields container)

Inputs

Outputs

Configurations

Scripting

result: global added mass (percentage) (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: global center of mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam S shear force (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam S bending moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: beam RS shear stress (LSDyna)

Inputs

Outputs

Configurations

Scripting

utility: merge fields into field matrix

Inputs

Outputs

Configurations

Scripting

result: beam axial plastic strain (LSDyna)

Inputs

Outputs

Configurations

Scripting

invariant: von mises eqv (field)

Inputs

Outputs

Configurations

Scripting

invariant: segalman von mises eqv (field)

Inputs

Outputs

Configurations

Scripting

result: part eroded internal energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: part kinetic energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

scoping: on mesh property

Inputs

Outputs

Configurations

Scripting

scoping: from mesh

Inputs

Outputs

Configurations

Scripting

result: part added mass (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: part hourglass energy (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: part rigid body velocity (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: interface contact force (LSDyna)

Inputs

Outputs

Configurations

Scripting

min_max: time of max

Inputs

Outputs

Configurations

Scripting

scoping: nodes in mesh

Inputs

Outputs

Configurations

Scripting

metadata: cyclic support provider

Inputs

Outputs

Configurations

Scripting

result: interface resultant contact force (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: interface contact moment (LSDyna)

Inputs

Outputs

Configurations

Scripting

result: density

Inputs

Outputs

Configurations

Scripting

result: spectrum data

Inputs

Outputs

Configurations

Scripting

averaging: elemental to elemental nodal (fields container)

Inputs

Outputs

Configurations

Scripting

result: total pressure

Inputs

Outputs

Configurations

Scripting

result: mean velocity

Inputs

Outputs

Configurations

Scripting

result: Lighthill tensor divergence

Inputs

Outputs

Configurations

Scripting

result: mass flow rate

Inputs

Outputs

Configurations

Scripting

result: mach number

Inputs

Outputs

Configurations

Scripting

result: rms temperature

Inputs

Outputs

Configurations

Scripting

scoping: scoping get attribute

Inputs

Outputs

Configurations

Scripting

result: read cms_rbd file

Inputs

Outputs

Configurations

Scripting

result: mean temperature

Inputs

Outputs

Configurations

Scripting

result: surface heat rate

Inputs

Outputs

Configurations

Scripting

result: thermal conductivity

Inputs

Outputs

Configurations

Scripting

utility: extract scoping

Inputs

Outputs

Configurations

Scripting

result: specific heat

Inputs

Outputs

Configurations

Scripting

result: turbulent dissipation rate (epsilon)

Inputs

Outputs

Configurations

Scripting

metadata: time freq provider

Inputs

Outputs

Configurations

Scripting

metadata: mesh info provider

Inputs

Outputs

Configurations

Scripting

result: von mises stresses as mechanical

Inputs

Outputs

Configurations

Scripting

metadata: streams provider

Inputs

Outputs

Configurations

Scripting

result: poynting vector surface

Inputs

Outputs

Configurations

Scripting

metadata: datasources provider

Inputs

Outputs

Configurations

Scripting

scoping: rescope

Inputs

Outputs

Configurations

Scripting

filter: low pass (timescoping)

Inputs

Outputs

Configurations

Scripting

utility: data sources get attribute

Inputs

Outputs

Configurations

Scripting

mesh: meshes provider

Inputs

Outputs

Configurations

Scripting

metadata: mesh selection manager provider

Inputs

Outputs

Configurations

Scripting

utility: for each

Inputs

Outputs

Configurations

Scripting

metadata: boundary condition provider

Inputs

Outputs

Configurations

Scripting

utility: merge property fields

Inputs

Outputs

Configurations

Scripting

metadata: cyclic analysis?

Inputs

Outputs

Configurations

Scripting

metadata: material support provider

Inputs

Outputs

Configurations

Scripting

scoping: on named selection

Inputs

Outputs

Configurations

Scripting

scoping: reduce sampling scoping

Inputs

Outputs

Configurations

Scripting

math: accumulation per scoping

Inputs

Outputs

Configurations

Scripting

metadata: real constants provider

Inputs

Outputs

Configurations

Scripting

metadata: coordinate system data provider

Inputs

Outputs

Configurations

Scripting

result: coordinate system

Inputs

Outputs

Configurations

Scripting

logic: splitter::streams

Inputs

Outputs

Configurations

Scripting

serialization: hdf5dpf custom read

Inputs

Outputs

Configurations

Scripting

result: nodal_to_global

Inputs

Outputs

Configurations

Scripting

scoping: rescope custom type field

Inputs

Outputs

Configurations

Scripting

result: global_to_nodal

Inputs

Outputs

Configurations

Scripting

min_max: min max by entity over time

Inputs

Outputs

Configurations

Scripting

result: rigid transformation provider

Inputs

Outputs

Configurations

Scripting

min_max: max over time

Inputs

Outputs

Configurations

Scripting

scoping: connectivity ids

Inputs

Outputs

Configurations

Scripting

utility: remote workflow instantiate

Inputs

Outputs

Configurations

Scripting

utility: remote operator instantiate

Inputs

Outputs

Configurations

Scripting

math: compute residual and error

Configurating operators 2 for normalized by the max at a given time step of the first entry or residuals depending on the reference field option, 3 for normalized by the max over all time steps of the first entry or residuals depending on the reference field option" types="int32" optional="true"ellipsis="false"inplace="false">

Outputs

Configurations

Scripting

result: add rigid body motion (fields container)

Inputs

Outputs

Configurations

Scripting

utility: merge time freq supports

Inputs

Outputs

Configurations

Scripting

min_max: incremental over fields container

Inputs

Outputs

Configurations

Scripting

scoping: split on property type

Inputs

Outputs

Configurations

Scripting

utility: overlap fields

Inputs

Outputs

Configurations

Scripting

averaging: elemental nodal to nodal elemental (field)

Inputs

Outputs

Configurations

Scripting

scoping: adapt with scopings container

Inputs

Outputs

Configurations

Scripting

utility: change shell layers

Inputs

Outputs

Configurations

Scripting

utility: merge meshes

Inputs

Outputs

Configurations

Scripting

utility: merge fields

Inputs

Outputs

Configurations

Scripting

utility: merge weighted fields

Inputs

Outputs

Configurations

Scripting

utility: merge fc to fc field matrices

Inputs

Outputs

Configurations

Scripting

filter: high pass (field)

Inputs

Outputs

Configurations

Scripting

min_max: max by component

Inputs

Outputs

Configurations

Scripting

utility: weighted merge fields by label

Inputs

Outputs

Configurations

Scripting

utility: merge fields by label

Inputs

Outputs

Configurations

Scripting

averaging: elemental to elemental nodal (field)

Inputs

Outputs

Configurations

Scripting

min_max: min max by entity

Inputs

Outputs

Configurations

Scripting

utility: merge collections

Inputs

Outputs

Configurations

Scripting

logic: merge solid and shell fields

Inputs

Outputs

Configurations

Scripting

min_max: min over time

Inputs

Outputs

Configurations

Scripting

geo: element nodal contribution

Inputs

Outputs

Configurations

Scripting

min_max: over label

Inputs

Outputs

Configurations

Scripting

min_max: min by component

Inputs

Outputs

Configurations

Scripting

serialization: serializer to string

Inputs

Outputs

Configurations

Scripting

serialization: deserializer

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded velocity

Inputs

Outputs

Configurations

Scripting

mesh: skin

Inputs

Outputs

Configurations

Scripting

utility: split in for each range

Inputs

Outputs

Configurations

Scripting

utility: make for each range

Inputs

Outputs

Configurations

Scripting

utility: incremental field

Inputs

Outputs

Configurations

Scripting

utility: incremental fields container

Inputs

Outputs

Configurations

Scripting

geo: rotate (fields container)

Inputs

Outputs

Configurations

Scripting

utility: incremental property field

Inputs

Outputs

Configurations

Scripting

utility: incremental mesh

Inputs

Outputs

Configurations

Scripting

mesh: points from coordinates

Inputs

Outputs

Configurations

Scripting

utility: incremental concantenate as fields container.

Inputs

Outputs

Configurations

Scripting

utility: make producer consumer for each iterator

Inputs

Outputs

Configurations

Scripting

utility: producer consumer for each

Inputs

Outputs

Configurations

Scripting

averaging: extend to mid nodes (field)

Inputs

Outputs

Configurations

Scripting

invariant: eigen vectors (on fields container)

Inputs

Outputs

Configurations

Scripting

mesh: mesh get attribute

Inputs

Outputs

Configurations

Scripting

metadata: time freq support get attribute

Inputs

Outputs

Configurations

Scripting

utility: set attribute

Inputs

Outputs

Configurations

Scripting

utility: field get attribute

Inputs

Outputs

Configurations

Scripting

min_max: time of min

Inputs

Outputs

Configurations

Scripting

min_max: max over phase

Inputs

Outputs

Configurations

Scripting

min_max: phase of max

Inputs

Outputs

Configurations

Scripting

utility: voigt to standard strains

Inputs

Outputs

Configurations

Scripting

utility: voigt to standard strains (fields container)

Inputs

Outputs

Configurations

Scripting

min_max: incremental over field

Inputs

Outputs

Configurations

Scripting

utility: workflow to pydpf generator

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (timefreq)

Inputs

Outputs

Configurations

Scripting

logic: same string fields?

Inputs

Outputs

Configurations

Scripting

logic: same meshes?

Inputs

Outputs

Configurations

Scripting

logic: same fields?

Inputs

Outputs

Configurations

Scripting

logic: fields included?

Inputs

Outputs

Configurations

Scripting

logic: same fields container?

Inputs

Outputs

Configurations

Scripting

filter: high pass (scoping)

Inputs

Outputs

Configurations

Scripting

filter: high pass (timescoping)

Inputs

Outputs

Configurations

Scripting

filter: high pass (fields container)

Inputs

Outputs

Configurations

Scripting

filter: low pass (field)

Inputs

Outputs

Configurations

Scripting

filter: low pass (fields container)

Inputs

Outputs

Configurations

Scripting

filter: band pass (scoping)

Inputs

Outputs

Configurations

Scripting

filter: band pass (timefreq)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (scoping)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (timescoping)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (fields container)

Inputs

Outputs

Configurations

Scripting

serialization: csv to field

Inputs

Outputs

Configurations

Scripting

result: members in compression not certified

Inputs

Outputs

Configurations

Scripting

result: members in bending not certified

Inputs

Outputs

Configurations

Scripting

result: members in linear compression bending not certified

Inputs

Outputs

Configurations

Scripting

invariant: convertnum nod to bcs

Inputs

Outputs

Configurations

Scripting

geo: rotate

Inputs

Outputs

Configurations

Scripting

logic: enrich materials

Inputs

Outputs

Configurations

Scripting

serialization: data tree to json

Inputs

Outputs

Configurations

Scripting

serialization: data tree to txt

Inputs

Outputs

Configurations

Scripting

serialization: json to data tree

Inputs

Outputs

Configurations

Scripting

averaging: nodal difference (fields container)

Inputs

Outputs

Configurations

Scripting

logic: descending sort

Inputs

Outputs

Configurations

Scripting

logic: ascending sort (fields container)

Inputs

Outputs

Configurations

Scripting

logic: descending sort (fields container)

Inputs

Outputs

Configurations

Scripting

serialization: import symbolic workflow

Inputs

Outputs

Configurations

Scripting

filter: filtering max over time workflow

Inputs

Outputs

Configurations

Scripting

metadata: integrate over time freq

Inputs

Outputs

Configurations

Scripting

utility: extract time freq

Inputs

Outputs

Configurations

Scripting

averaging: nodal difference (field)

Inputs

Outputs

Configurations

Scripting

result: compute stress YZ

Inputs

Outputs

Configurations

Scripting

logic: splitter::data_sources

Inputs

Outputs

Configurations

Scripting

averaging: to elemental nodal (fields container)

Inputs

Outputs

Configurations

Scripting

server: grpc start server

Inputs

Outputs

Configurations

Scripting

result: compute stress XY

Inputs

Outputs

Configurations

Scripting

utility: operator id

Inputs

Outputs

Configurations

Scripting

averaging: elemental nodal to nodal (field)

Inputs

Outputs

Configurations

Scripting

averaging: elemental nodal to nodal (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: elemental to nodal (field)

Outputs

Configurations

Scripting

result: add rigid body motion (fields container)

Inputs

Outputs

Configurations

Scripting

utility: merge time freq supports

Inputs

Outputs

Configurations

Scripting

min_max: incremental over fields container

Inputs

Outputs

Configurations

Scripting

scoping: split on property type

Inputs

Outputs

Configurations

Scripting

utility: overlap fields

Inputs

Outputs

Configurations

Scripting

averaging: elemental nodal to nodal elemental (field)

Inputs

Outputs

Configurations

Scripting

scoping: adapt with scopings container

Inputs

Outputs

Configurations

Scripting

utility: change shell layers

Inputs

Outputs

Configurations

Scripting

utility: merge meshes

Inputs

Outputs

Configurations

Scripting

utility: merge fields

Inputs

Outputs

Configurations

Scripting

utility: merge weighted fields

Inputs

Outputs

Configurations

Scripting

utility: merge fc to fc field matrices

Inputs

Outputs

Configurations

Scripting

filter: high pass (field)

Inputs

Outputs

Configurations

Scripting

utility: weighted merge fields by label

Inputs

Outputs

Configurations

Scripting

min_max: max by component

Inputs

Outputs

Configurations

Scripting

utility: merge fields by label

Inputs

Outputs

Configurations

Scripting

averaging: elemental to elemental nodal (field)

Inputs

Outputs

Configurations

Scripting

min_max: min max by entity

Inputs

Outputs

Configurations

Scripting

utility: merge collections

Inputs

Outputs

Configurations

Scripting

logic: merge solid and shell fields

Inputs

Outputs

Configurations

Scripting

min_max: min over time

Inputs

Outputs

Configurations

Scripting

geo: element nodal contribution

Inputs

Outputs

Configurations

Scripting

min_max: over field

Inputs

Outputs

Configurations

Scripting

result: transient rayleigh integration

Inputs

Outputs

Configurations

Scripting

min_max: over fields container

Inputs

Outputs

Configurations

Scripting

min_max: over label

Inputs

Outputs

Configurations

Scripting

min_max: min by component

Inputs

Outputs

Configurations

Scripting

math: average over label

Inputs

Outputs

Configurations

Scripting

math: accumulate level over label

Inputs

Outputs

Configurations

Scripting

serialization: serializer to string

Inputs

Outputs

Configurations

Scripting

serialization: deserializer

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded velocity

Inputs

Outputs

Configurations

Scripting

mesh: skin

Inputs

Outputs

Configurations

Scripting

utility: split in for each range

Inputs

Outputs

Configurations

Scripting

utility: make for each range

Inputs

Outputs

Configurations

Scripting

utility: incremental field

Inputs

Outputs

Configurations

Scripting

utility: incremental fields container

Inputs

Outputs

Configurations

Scripting

geo: rotate (fields container)

Inputs

Outputs

Configurations

Scripting

utility: incremental property field

Inputs

Outputs

Configurations

Scripting

utility: incremental mesh

Inputs

Outputs

Configurations

Scripting

mesh: points from coordinates

Inputs

Outputs

Configurations

Scripting

utility: incremental concantenate as fields container.

Inputs

Outputs

Configurations

Scripting

utility: make producer consumer for each iterator

Inputs

Outputs

Configurations

Scripting

utility: producer consumer for each

Inputs

Outputs

Configurations

Scripting

averaging: extend to mid nodes (field)

Inputs

Outputs

Configurations

Scripting

invariant: eigen vectors (on fields container)

Inputs

Outputs

Configurations

Scripting

mesh: mesh get attribute

Inputs

Outputs

Configurations

Scripting

metadata: time freq support get attribute

Inputs

Outputs

Configurations

Scripting

utility: set attribute

Inputs

Outputs

Configurations

Scripting

utility: field get attribute

Inputs

Outputs

Configurations

Scripting

min_max: time of min

Inputs

Outputs

Configurations

Scripting

min_max: max over phase

Inputs

Outputs

Configurations

Scripting

min_max: phase of max

Inputs

Outputs

Configurations

Scripting

utility: voigt to standard strains

Inputs

Outputs

Configurations

Scripting

utility: voigt to standard strains (fields container)

Inputs

Outputs

Configurations

Scripting

min_max: incremental over field

Inputs

Outputs

Configurations

Scripting

utility: workflow to pydpf generator

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (timefreq)

Inputs

Outputs

Configurations

Scripting

logic: same string fields?

Inputs

Outputs

Configurations

Scripting

logic: same meshes?

Inputs

Outputs

Configurations

Scripting

logic: same fields?

Inputs

Outputs

Configurations

Scripting

logic: fields included?

Inputs

Outputs

Configurations

Scripting

logic: same fields container?

Inputs

Outputs

Configurations

Scripting

filter: high pass (scoping)

Inputs

Outputs

Configurations

Scripting

filter: high pass (timescoping)

Inputs

Outputs

Configurations

Scripting

filter: high pass (fields container)

Inputs

Outputs

Configurations

Scripting

filter: low pass (field)

Inputs

Outputs

Configurations

Scripting

filter: low pass (fields container)

Inputs

Outputs

Configurations

Scripting

filter: band pass (scoping)

Inputs

Outputs

Configurations

Scripting

filter: band pass (timefreq)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (scoping)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (timescoping)

Inputs

Outputs

Configurations

Scripting

filter: signed high pass (fields container)

Inputs

Outputs

Configurations

Scripting

serialization: csv to field

Inputs

Outputs

Configurations

Scripting

result: members in compression not certified

Inputs

Outputs

Configurations

Scripting

result: members in bending not certified

Inputs

Outputs

Configurations

Scripting

result: members in linear compression bending not certified

Inputs

Outputs

Configurations

Scripting

invariant: convertnum nod to bcs

Inputs

Outputs

Configurations

Scripting

geo: rotate

Inputs

Outputs

Configurations

Scripting

logic: enrich materials

Inputs

Outputs

Configurations

Scripting

serialization: data tree to json

Inputs

Outputs

Configurations

Scripting

serialization: data tree to txt

Inputs

Outputs

Configurations

Scripting

serialization: json to data tree

Inputs

Outputs

Configurations

Scripting

averaging: nodal difference (fields container)

Inputs

Outputs

Configurations

Scripting

logic: descending sort

Inputs

Outputs

Configurations

Scripting

logic: ascending sort (fields container)

Inputs

Outputs

Configurations

Scripting

logic: descending sort (fields container)

Inputs

Outputs

Configurations

Scripting

serialization: import symbolic workflow

Inputs

Outputs

Configurations

Scripting

filter: filtering max over time workflow

Inputs

Outputs

Configurations

Scripting

metadata: integrate over time freq

Inputs

Outputs

Configurations

Scripting

utility: extract time freq

Inputs

Outputs

Configurations

Scripting

averaging: nodal difference (field)

Inputs

Outputs

Configurations

Scripting

result: compute stress YZ

Inputs

Outputs

Configurations

Scripting

logic: splitter::data_sources

Inputs

Outputs

Configurations

Scripting

averaging: to elemental nodal (fields container)

Inputs

Outputs

Configurations

Scripting

server: grpc start server

Inputs

Outputs

Configurations

Scripting

result: compute stress XY

Inputs

Outputs

Configurations

Scripting

utility: operator id

Inputs

Outputs

Configurations

Scripting

averaging: elemental nodal to nodal (field)

Inputs

Outputs

Configurations

Scripting

averaging: elemental nodal to nodal (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: elemental to nodal (field)

Configurating operators - If the determinant of the I matrix is zero, switch to an inverse distance weighted average. - If not, compute the Frink weights and apply the Holmes' weight clip. - If the clipping produces a large overshoot, inverse volume weighted average is used.. -3. For a face finite volume mesh inverse distance weighted average is used.">

Inputs

Outputs

Configurations

Scripting

averaging: to nodal (field)

Inputs

Outputs

Configurations

Scripting

averaging: to nodal (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: elemental mean (field)

Inputs

Outputs

Configurations

Scripting

averaging: elemental mean (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental (field)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental nodal (field)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental nodal (fields container)

Inputs

Outputs

Configurations

Scripting

invariant: eigen values (field)

Inputs

Outputs

Configurations

Scripting

invariant: principal invariants (field)

Inputs

Outputs

Configurations

Scripting

invariant: von mises eqv (fields container)

Inputs

Outputs

Configurations

Scripting

invariant: segalman von mises eqv (fields container)

Inputs

Outputs

Configurations

Scripting

scoping: compute element centroids

Inputs

Outputs

Configurations

Scripting

math: entity extractor

Inputs

Outputs

Configurations

Scripting

metadata: cyclic mesh expansion

Inputs

Outputs

Configurations

Scripting

result: cyclic analytic stress eqv max

Inputs

Outputs

Configurations

Scripting

result: remove rigid body motion (fields container)

Inputs

Outputs

Configurations

Scripting

result: cyclic expansion

Inputs

Outputs

Configurations

Scripting

averaging: nodal fraction (fields container)

Inputs

Outputs

Configurations

Scripting

result: recombine cyclic harmonic indices

Inputs

Outputs

Configurations

Scripting

mapping: on coordinates

Inputs

Outputs

Configurations

Scripting

mapping: scoping on coordinates

Inputs

Outputs

Configurations

Scripting

filter: abc weightings

Inputs

Outputs

Configurations

Scripting

mapping: solid to skin

Inputs

Outputs

Configurations

Scripting

mapping: solid to skin (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: elemental difference (field)

Inputs

Outputs

Configurations

Scripting

averaging: elemental fraction (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: extend to mid nodes (fields container)

Inputs

Outputs

Configurations

Scripting

geo: rotate cylindrical coordinates

Inputs

Outputs

Configurations

Scripting

geo: rotate in cylindrical coordinates (fields container)

Inputs

Outputs

Configurations

Scripting

geo: spherical to cartesian coordinates (fields container)

Inputs

Outputs

Configurations

Scripting

geo: spherical to cartesian coordinates

Inputs

Outputs

Configurations

Scripting

mesh: change cs (meshes)

Inputs

Outputs

Configurations

Scripting

geo: normals provider nl (nodes, faces, or elements)

Inputs

Outputs

Configurations

Scripting

geo: elements volumes over time

Inputs

Outputs

Configurations

Scripting

math: window bartlett

Inputs

Outputs

Configurations

Scripting

mesh: from scoping

Inputs

Outputs

Configurations

Scripting

mesh: split field wrt mesh regions

Inputs

Outputs

Configurations

Scripting

result: torque

Inputs

Outputs

Configurations

Scripting

result: euler load buckling

Inputs

Outputs

Configurations

Scripting

geo: faces area

Inputs

Outputs

Configurations

Scripting

result: compute stress 3

Inputs

Outputs

Configurations

Scripting

geo: gauss to node (field)

Inputs

Outputs

Configurations

Scripting

averaging: gauss to node (fields container)

Inputs

Outputs

Configurations

Scripting

math: correlation

Inputs

Outputs

Configurations

Scripting

math: mac

Inputs

Outputs

Configurations

Scripting

result: workflow energy per component

Inputs

Outputs

Configurations

Scripting

result: add rigid body motion (field)

Inputs

Outputs

Configurations

Scripting

result: split on facet indices

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded temperature

Inputs

Outputs

Configurations

Scripting

result: enf solution to global cs

Inputs

Outputs

Configurations

Scripting

result: cms matrices provider

Inputs

Outputs

Configurations

Scripting

result: rom data provider

Inputs

Outputs

Configurations

Scripting

result: prns to field

Inputs

Outputs

Configurations

Scripting

result: remove rigid body motion (field)

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded displacement

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded acceleration

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded stress

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded el strain

Inputs

Outputs

Configurations

Scripting

result: cms subfile info provider

Inputs

Outputs

Configurations

Scripting

result: cyclic volume

Inputs

Outputs

Configurations

Scripting

result: cyclic nmisc

Inputs

Outputs

Configurations

Scripting

invariant: convertnum operator

Inputs

Outputs

Configurations

Scripting

result: compute total strain XZ

Inputs

Outputs

Configurations

Scripting

averaging: to nodal (field)

Inputs

Outputs

Configurations

Scripting

averaging: to nodal (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: elemental mean (field)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental (field)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental nodal (field)

Inputs

Outputs

Configurations

Scripting

averaging: nodal to elemental nodal (fields container)

Inputs

Outputs

Configurations

Scripting

invariant: eigen values (field)

Inputs

Outputs

Configurations

Scripting

invariant: principal invariants (field)

Inputs

Outputs

Configurations

Scripting

invariant: von mises eqv (fields container)

Inputs

Outputs

Configurations

Scripting

invariant: segalman von mises eqv (fields container)

Inputs

Outputs

Configurations

Scripting

scoping: compute element centroids

Inputs

Outputs

Configurations

Scripting

math: entity extractor

Inputs

Outputs

Configurations

Scripting

metadata: cyclic mesh expansion

Inputs

Outputs

Configurations

Scripting

result: cyclic analytic stress eqv max

Inputs

Outputs

Configurations

Scripting

result: remove rigid body motion (fields container)

Inputs

Outputs

Configurations

Scripting

result: cyclic expansion

Inputs

Outputs

Configurations

Scripting

averaging: nodal fraction (fields container)

Inputs

Outputs

Configurations

Scripting

result: recombine cyclic harmonic indices

Inputs

Outputs

Configurations

Scripting

mapping: on coordinates

Inputs

Outputs

Configurations

Scripting

mapping: scoping on coordinates

Inputs

Outputs

Configurations

Scripting

filter: abc weightings

Inputs

Outputs

Configurations

Scripting

mapping: solid to skin

Inputs

Outputs

Configurations

Scripting

mapping: solid to skin (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: elemental difference (field)

Inputs

Outputs

Configurations

Scripting

averaging: elemental fraction (fields container)

Inputs

Outputs

Configurations

Scripting

averaging: extend to mid nodes (fields container)

Inputs

Outputs

Configurations

Scripting

geo: rotate cylindrical coordinates

Inputs

Outputs

Configurations

Scripting

geo: rotate in cylindrical coordinates (fields container)

Inputs

Outputs

Configurations

Scripting

geo: spherical to cartesian coordinates (fields container)

Inputs

Outputs

Configurations

Scripting

geo: spherical to cartesian coordinates

Inputs

Outputs

Configurations

Scripting

mesh: change cs (meshes)

Inputs

Outputs

Configurations

Scripting

geo: normals provider nl (nodes, faces, or elements)

Inputs

Outputs

Configurations

Scripting

geo: elements volumes over time

Inputs

Outputs

Configurations

Scripting

math: window bartlett

Inputs

Outputs

Configurations

Scripting

mesh: from scoping

Inputs

Outputs

Configurations

Scripting

mesh: split field wrt mesh regions

Inputs

Outputs

Configurations

Scripting

result: torque

Inputs

Outputs

Configurations

Scripting

result: euler load buckling

Inputs

Outputs

Configurations

Scripting

geo: faces area

Inputs

Outputs

Configurations

Scripting

result: compute stress 3

Inputs

Outputs

Configurations

Scripting

geo: gauss to node (field)

Inputs

Outputs

Configurations

Scripting

averaging: gauss to node (fields container)

Inputs

Outputs

Configurations

Scripting

math: correlation

Inputs

Outputs

Configurations

Scripting

math: mac

Inputs

Outputs

Configurations

Scripting

result: workflow energy per component

Inputs

Outputs

Configurations

Scripting

result: add rigid body motion (field)

Inputs

Outputs

Configurations

Scripting

result: split on facet indices

Inputs

Outputs

Configurations

Scripting

result: enf solution to global cs

Inputs

Outputs

Configurations

Scripting

result: cms matrices provider

Inputs

Outputs

Configurations

Scripting

result: rom data provider

Inputs

Outputs

Configurations

Scripting

result: prns to field

Inputs

Outputs

Configurations

Scripting

result: remove rigid body motion (field)

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded displacement

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded acceleration

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded stress

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded el strain

Inputs

Outputs

Configurations

Scripting

result: cms subfile info provider

Inputs

Outputs

Configurations

Scripting

result: cyclic volume

Inputs

Outputs

Configurations

Scripting

result: cyclic nmisc

Inputs

Outputs

Configurations

Scripting

invariant: convertnum operator

Inputs

Outputs

Configurations

Scripting

result: compute total strain XZ

Configurating operators Only linear analysis are supported without On Demand Expansion. All coordinates are global coordinates. Euler Angles need to be included in the database. - Get the XZ shear component (02 component).">

Inputs

Outputs

Configurations

Scripting

result: cms dst table provider

Inputs

Outputs

Configurations

Scripting

result: write motion dfmf file

Inputs

Outputs

Configurations

Scripting

invariant: eigen vectors (on field)

Inputs

Outputs

Configurations

Scripting

result: mapdl material properties

Inputs

Outputs

Configurations

Scripting

result: mapdl_section

Inputs

Outputs

Configurations

Scripting

result: compute invariant terms motion

Inputs

Outputs

Configurations

Scripting

result: split to acmo facet indices

Inputs

Outputs

Configurations

Scripting

result: stress solution to global cs

Inputs

Outputs

Configurations

Scripting

result: elastic strain solution to global cs

Inputs

Outputs

Configurations

Scripting

result: plastic strain to global cs

Inputs

Outputs

Configurations

Scripting

math: qr solve

Inputs

Outputs

Configurations

Scripting

result: von mises strains as mechanical workflow

Inputs

Outputs

Configurations

Scripting

mesh: mesh clipper

Inputs

Outputs

Configurations

Scripting

serialization: migrate to vtk

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded element heat flux

Inputs

Outputs

Configurations

Scripting

mesh: external layer

Inputs

Outputs

Configurations

Scripting

mesh: mesh cutter

Inputs

Outputs

Configurations

Scripting

mesh: mesh plan clipper

Inputs

Outputs

Configurations

Scripting

mesh: mesh_to_graphics

Inputs

Outputs

Configurations

Scripting

mesh: mesh_to_graphics_edges

Inputs

Outputs

Configurations

Scripting

geo: scoping normals

Inputs

Outputs

Configurations

Scripting

mesh: combine levelset

Inputs

Outputs

Configurations

Scripting

mesh: exclude levelset

Inputs

Outputs

Configurations

Scripting

mesh: make plane levelset

Inputs

Outputs

Configurations

Scripting

mesh: make sphere levelset

Inputs

Outputs

Configurations

Scripting

mesh: mesh extraction

Inputs

Outputs

Configurations

Scripting

mesh: wireframe

Inputs

Outputs

Configurations

Scripting

mesh: mesh to tetra

Inputs

Outputs

Configurations

Scripting

mapping: fft

Inputs

Outputs

Configurations

Scripting

math: fft gradient evaluation

Inputs

Outputs

Configurations

Scripting

math: fft multi harmonic solution minmax

Inputs

Outputs

Configurations

Scripting

math: svd

Inputs

Outputs

Configurations

Scripting

math: time integration

Inputs

Outputs

Configurations

Scripting

math: time derivation

Inputs

Outputs

Configurations

Scripting

mapping: prep sampling fft

Inputs

Outputs

Configurations

Scripting

math: fft filtering and cubic fitting

Inputs

Outputs

Configurations

Scripting

math: window triangular

Inputs

Outputs

Configurations

Scripting

math: window hanning

Inputs

Outputs

Configurations

Scripting

math: window hamming

Inputs

Outputs

Configurations

Scripting

math: window welch

Inputs

Outputs

Configurations

Scripting

math: window blackman

Inputs

Outputs

Configurations

Scripting

math: window triangular (fields container)

Inputs

Outputs

Configurations

Scripting

math: window hanning (fields container)

Inputs

Outputs

Configurations

Scripting

math: window hamming (fields container)

Inputs

Outputs

Configurations

Scripting

math: window welch (fields container)

Inputs

Outputs

Configurations

Scripting

math: window blackman (fields container)

Inputs

Outputs

Configurations

Scripting

serialization: hdf5dpf generate result file

Inputs

Outputs

Configurations

Scripting

result: migrate to h5dpf

Inputs

Outputs

Configurations

Scripting

result: cgns result provider

Inputs

Outputs

Configurations

Scripting

result: von mises stresses as mechanical workflow

Inputs

Outputs

Configurations

Scripting

utility: hdf5dpf workflow provider

Inputs

Outputs

Configurations

Scripting

other: hdf5dpf mesh property provider

Inputs

Outputs

Configurations

Scripting

serialization: migrate to vtu

Inputs

Outputs

Configurations

Scripting

serialization: vtu export

Inputs

Outputs

Configurations

Scripting

result: compute total strain Y

Inputs

Outputs

Configurations

Scripting

result: cms dst table provider

Inputs

Outputs

Configurations

Scripting

result: write motion dfmf file

Inputs

Outputs

Configurations

Scripting

invariant: eigen vectors (on field)

Inputs

Outputs

Configurations

Scripting

result: mapdl material properties

Inputs

Outputs

Configurations

Scripting

result: mapdl_section

Inputs

Outputs

Configurations

Scripting

result: compute invariant terms motion

Inputs

Outputs

Configurations

Scripting

result: split to acmo facet indices

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded element heat flux

Inputs

Outputs

Configurations

Scripting

result: stress solution to global cs

Inputs

Outputs

Configurations

Scripting

result: elastic strain solution to global cs

Inputs

Outputs

Configurations

Scripting

result: plastic strain to global cs

Inputs

Outputs

Configurations

Scripting

math: qr solve

Inputs

Outputs

Configurations

Scripting

result: von mises strains as mechanical workflow

Inputs

Outputs

Configurations

Scripting

mesh: mesh clipper

Inputs

Outputs

Configurations

Scripting

serialization: migrate to vtk

Inputs

Outputs

Configurations

Scripting

result: cyclic expanded temperature

Inputs

Outputs

Configurations

Scripting

mesh: external layer

Inputs

Outputs

Configurations

Scripting

mesh: mesh cutter

Inputs

Outputs

Configurations

Scripting

mesh: mesh plan clipper

Inputs

Outputs

Configurations

Scripting

mesh: mesh_to_graphics

Inputs

Outputs

Configurations

Scripting

mesh: mesh_to_graphics_edges

Inputs

Outputs

Configurations

Scripting

geo: scoping normals

Inputs

Outputs

Configurations

Scripting

mesh: combine levelset

Inputs

Outputs

Configurations

Scripting

mesh: exclude levelset

Inputs

Outputs

Configurations

Scripting

mesh: make plane levelset

Inputs

Outputs

Configurations

Scripting

mesh: make sphere levelset

Inputs

Outputs

Configurations

Scripting

mesh: mesh extraction

Inputs

Outputs

Configurations

Scripting

mesh: wireframe

Inputs

Outputs

Configurations

Scripting

mesh: mesh to tetra

Inputs

Outputs

Configurations

Scripting

mapping: fft

Inputs

Outputs

Configurations

Scripting

math: fft gradient evaluation

Inputs

Outputs

Configurations

Scripting

math: fft multi harmonic solution minmax

Inputs

Outputs

Configurations

Scripting

math: svd

Inputs

Outputs

Configurations

Scripting

math: time integration

Inputs

Outputs

Configurations

Scripting

math: time derivation

Inputs

Outputs

Configurations

Scripting

mapping: prep sampling fft

Inputs

Outputs

Configurations

Scripting

math: fft filtering and cubic fitting

Inputs

Outputs

Configurations

Scripting

math: window triangular

Inputs

Outputs

Configurations

Scripting

math: window hanning

Inputs

Outputs

Configurations

Scripting

math: window hamming

Inputs

Outputs

Configurations

Scripting

math: window welch

Inputs

Outputs

Configurations

Scripting

math: window blackman

Inputs

Outputs

Configurations

Scripting

math: window triangular (fields container)

Inputs

Outputs

Configurations

Scripting

math: window hanning (fields container)

Inputs

Outputs

Configurations

Scripting

math: window hamming (fields container)

Inputs

Outputs

Configurations

Scripting

math: window welch (fields container)

Inputs

Outputs

Configurations

Scripting

math: window blackman (fields container)

Inputs

Outputs

Configurations

Scripting

math: expansion psd

Inputs

Outputs

Configurations

Scripting

serialization: hdf5dpf generate result file

Inputs

Outputs

Configurations

Scripting

result: migrate to h5dpf

Inputs

Outputs

Configurations

Scripting

result: von mises stresses as mechanical workflow

Inputs

Outputs

Configurations

Scripting

utility: hdf5dpf workflow provider

Inputs

Outputs

Configurations

Scripting

other: hdf5dpf mesh property provider

Inputs

Outputs

Configurations

Scripting

serialization: migrate to vtu

Inputs

Outputs

Configurations

Scripting

serialization: vtu export

Inputs

Outputs

Configurations

Scripting

result: compute total strain Y

>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.math.expansion_psd() + + >>> # Make input connections + >>> my_mode_shapes = dpf.FieldsContainer() + >>> op.inputs.mode_shapes.connect(my_mode_shapes) + >>> my_static_shapes = dpf.FieldsContainer() + >>> op.inputs.static_shapes.connect(my_static_shapes) + >>> my_rel_rel_covar_matrix = dpf.FieldsContainer() + >>> op.inputs.rel_rel_covar_matrix.connect(my_rel_rel_covar_matrix) + >>> my_stat_stat_covar_matrix = dpf.FieldsContainer() + >>> op.inputs.stat_stat_covar_matrix.connect(my_stat_stat_covar_matrix) + >>> my_rel_stat_covar_matrix = dpf.FieldsContainer() + >>> op.inputs.rel_stat_covar_matrix.connect(my_rel_stat_covar_matrix) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.math.expansion_psd( + ... mode_shapes=my_mode_shapes, + ... static_shapes=my_static_shapes, + ... rel_rel_covar_matrix=my_rel_rel_covar_matrix, + ... stat_stat_covar_matrix=my_stat_stat_covar_matrix, + ... rel_stat_covar_matrix=my_rel_stat_covar_matrix, + ... ) + + >>> # Get output data + >>> result_psd = op.outputs.psd() + """ + + def __init__( + self, + mode_shapes=None, + static_shapes=None, + rel_rel_covar_matrix=None, + stat_stat_covar_matrix=None, + rel_stat_covar_matrix=None, + config=None, + server=None, + ): + super().__init__(name="expansion::psd", config=config, server=server) + self._inputs = InputsExpansionPsd(self) + self._outputs = OutputsExpansionPsd(self) + if mode_shapes is not None: + self.inputs.mode_shapes.connect(mode_shapes) + if static_shapes is not None: + self.inputs.static_shapes.connect(static_shapes) + if rel_rel_covar_matrix is not None: + self.inputs.rel_rel_covar_matrix.connect(rel_rel_covar_matrix) + if stat_stat_covar_matrix is not None: + self.inputs.stat_stat_covar_matrix.connect(stat_stat_covar_matrix) + if rel_stat_covar_matrix is not None: + self.inputs.rel_stat_covar_matrix.connect(rel_stat_covar_matrix) + + @staticmethod + def _spec(): + description = """Computes the PSD response for one-sigma solution.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="mode_shapes", + type_names=["fields_container"], + optional=False, + document="""Fields container containing the mode shapes + from modal analysis file: mode shapes + for dynamic and pseudo-static + displacements""", + ), + 1: PinSpecification( + name="static_shapes", + type_names=["fields_container"], + optional=True, + document="""Fields container containing the static shapes + (base excitations) from spectral + analysis file""", + ), + 2: PinSpecification( + name="rel_rel_covar_matrix", + type_names=["fields_container"], + optional=False, + document="""Fields container containing covariance + matrices from a psd file: covariance + matrix terms for + displacement/velocity/acceleration + mode-mode shapes""", + ), + 3: PinSpecification( + name="stat_stat_covar_matrix", + type_names=["fields_container"], + optional=True, + document="""Fields container containing covariance + matrices from a psd file: covariance + matrix terms for + displacement/velocity/acceleration + static-static shapes""", + ), + 4: PinSpecification( + name="rel_stat_covar_matrix", + type_names=["fields_container"], + optional=True, + document="""Fields container containing covariance + matrices from a psd file: covariance + matrix terms for + displacement/velocity/acceleration + mode-static shapes""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="psd", + type_names=["fields_container"], + optional=False, + document="""Psd solution per label""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="expansion::psd", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsExpansionPsd + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsExpansionPsd + """ + return super().outputs + + +class InputsExpansionPsd(_Inputs): + """Intermediate class used to connect user inputs to + expansion_psd operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> my_mode_shapes = dpf.FieldsContainer() + >>> op.inputs.mode_shapes.connect(my_mode_shapes) + >>> my_static_shapes = dpf.FieldsContainer() + >>> op.inputs.static_shapes.connect(my_static_shapes) + >>> my_rel_rel_covar_matrix = dpf.FieldsContainer() + >>> op.inputs.rel_rel_covar_matrix.connect(my_rel_rel_covar_matrix) + >>> my_stat_stat_covar_matrix = dpf.FieldsContainer() + >>> op.inputs.stat_stat_covar_matrix.connect(my_stat_stat_covar_matrix) + >>> my_rel_stat_covar_matrix = dpf.FieldsContainer() + >>> op.inputs.rel_stat_covar_matrix.connect(my_rel_stat_covar_matrix) + """ + + def __init__(self, op: Operator): + super().__init__(expansion_psd._spec().inputs, op) + self._mode_shapes = Input(expansion_psd._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._mode_shapes) + self._static_shapes = Input(expansion_psd._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._static_shapes) + self._rel_rel_covar_matrix = Input( + expansion_psd._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._rel_rel_covar_matrix) + self._stat_stat_covar_matrix = Input( + expansion_psd._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._stat_stat_covar_matrix) + self._rel_stat_covar_matrix = Input( + expansion_psd._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._rel_stat_covar_matrix) + + @property + def mode_shapes(self): + """Allows to connect mode_shapes input to the operator. + + Fields container containing the mode shapes + from modal analysis file: mode shapes + for dynamic and pseudo-static + displacements + + Parameters + ---------- + my_mode_shapes : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> op.inputs.mode_shapes.connect(my_mode_shapes) + >>> # or + >>> op.inputs.mode_shapes(my_mode_shapes) + """ + return self._mode_shapes + + @property + def static_shapes(self): + """Allows to connect static_shapes input to the operator. + + Fields container containing the static shapes + (base excitations) from spectral + analysis file + + Parameters + ---------- + my_static_shapes : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> op.inputs.static_shapes.connect(my_static_shapes) + >>> # or + >>> op.inputs.static_shapes(my_static_shapes) + """ + return self._static_shapes + + @property + def rel_rel_covar_matrix(self): + """Allows to connect rel_rel_covar_matrix input to the operator. + + Fields container containing covariance + matrices from a psd file: covariance + matrix terms for + displacement/velocity/acceleration + mode-mode shapes + + Parameters + ---------- + my_rel_rel_covar_matrix : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> op.inputs.rel_rel_covar_matrix.connect(my_rel_rel_covar_matrix) + >>> # or + >>> op.inputs.rel_rel_covar_matrix(my_rel_rel_covar_matrix) + """ + return self._rel_rel_covar_matrix + + @property + def stat_stat_covar_matrix(self): + """Allows to connect stat_stat_covar_matrix input to the operator. + + Fields container containing covariance + matrices from a psd file: covariance + matrix terms for + displacement/velocity/acceleration + static-static shapes + + Parameters + ---------- + my_stat_stat_covar_matrix : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> op.inputs.stat_stat_covar_matrix.connect(my_stat_stat_covar_matrix) + >>> # or + >>> op.inputs.stat_stat_covar_matrix(my_stat_stat_covar_matrix) + """ + return self._stat_stat_covar_matrix + + @property + def rel_stat_covar_matrix(self): + """Allows to connect rel_stat_covar_matrix input to the operator. + + Fields container containing covariance + matrices from a psd file: covariance + matrix terms for + displacement/velocity/acceleration + mode-static shapes + + Parameters + ---------- + my_rel_stat_covar_matrix : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> op.inputs.rel_stat_covar_matrix.connect(my_rel_stat_covar_matrix) + >>> # or + >>> op.inputs.rel_stat_covar_matrix(my_rel_stat_covar_matrix) + """ + return self._rel_stat_covar_matrix + + +class OutputsExpansionPsd(_Outputs): + """Intermediate class used to get outputs from + expansion_psd operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> # Connect inputs : op.inputs. ... + >>> result_psd = op.outputs.psd() + """ + + def __init__(self, op: Operator): + super().__init__(expansion_psd._spec().outputs, op) + self._psd = Output(expansion_psd._spec().output_pin(0), 0, op) + self._outputs.append(self._psd) + + @property + def psd(self): + """Allows to get psd output of the operator + + Returns + ---------- + my_psd : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.math.expansion_psd() + >>> # Connect inputs : op.inputs. ... + >>> result_psd = op.outputs.psd() + """ # noqa: E501 + return self._psd diff --git a/src/ansys/dpf/core/operators/metadata/__init__.py b/src/ansys/dpf/core/operators/metadata/__init__.py index 9355e95dce3..ff6641e6ec7 100644 --- a/src/ansys/dpf/core/operators/metadata/__init__.py +++ b/src/ansys/dpf/core/operators/metadata/__init__.py @@ -1,7 +1,9 @@ from .boundary_condition_provider import boundary_condition_provider +from .coordinate_system_data_provider import coordinate_system_data_provider from .cyclic_mesh_expansion import cyclic_mesh_expansion from .cyclic_support_provider import cyclic_support_provider from .datasources_provider import datasources_provider +from .element_types_provider import element_types_provider from .integrate_over_time_freq import integrate_over_time_freq from .is_cyclic import is_cyclic from .material_support_provider import material_support_provider @@ -10,6 +12,7 @@ from .mesh_selection_manager_provider import mesh_selection_manager_provider from .mesh_support_provider import mesh_support_provider from .property_field_provider_by_name import property_field_provider_by_name +from .real_constants_provider import real_constants_provider from .result_info_provider import result_info_provider from .streams_provider import streams_provider from .time_freq_provider import time_freq_provider diff --git a/src/ansys/dpf/core/operators/metadata/coordinate_system_data_provider.py b/src/ansys/dpf/core/operators/metadata/coordinate_system_data_provider.py new file mode 100644 index 00000000000..246db091dd8 --- /dev/null +++ b/src/ansys/dpf/core/operators/metadata/coordinate_system_data_provider.py @@ -0,0 +1,323 @@ +""" +coordinate_system_data_provider + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class coordinate_system_data_provider(Operator): + """Reads coordinate systems data from the result files contained in the + streams or data sources. + + Parameters + ---------- + solver_coordinate_system_ids : int, optional + Coorfinate system ids to recover used by the + solver. if not set, all available + materials to be recovered. + streams : StreamsContainer, optional + Result file container allowed to be kept open + to cache data. + data_sources : DataSources + Result file path container, used if no + streams are set. + + Returns + ------- + coordinate_system_data1 : GenericDataContainer + coordinate_system_data2 : GenericDataContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + + >>> # Make input connections + >>> my_solver_coordinate_system_ids = int() + >>> op.inputs.solver_coordinate_system_ids.connect(my_solver_coordinate_system_ids) + >>> my_streams = dpf.StreamsContainer() + >>> op.inputs.streams.connect(my_streams) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.metadata.coordinate_system_data_provider( + ... solver_coordinate_system_ids=my_solver_coordinate_system_ids, + ... streams=my_streams, + ... data_sources=my_data_sources, + ... ) + + >>> # Get output data + >>> result_coordinate_system_data1 = op.outputs.coordinate_system_data1() + >>> result_coordinate_system_data2 = op.outputs.coordinate_system_data2() + """ + + def __init__( + self, + solver_coordinate_system_ids=None, + streams=None, + data_sources=None, + config=None, + server=None, + ): + super().__init__( + name="coordinate_systems_data_provider", config=config, server=server + ) + self._inputs = InputsCoordinateSystemDataProvider(self) + self._outputs = OutputsCoordinateSystemDataProvider(self) + if solver_coordinate_system_ids is not None: + self.inputs.solver_coordinate_system_ids.connect( + solver_coordinate_system_ids + ) + if streams is not None: + self.inputs.streams.connect(streams) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + + @staticmethod + def _spec(): + description = """Reads coordinate systems data from the result files contained in the + streams or data sources.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 1: PinSpecification( + name="solver_coordinate_system_ids", + type_names=["int32", "vector"], + optional=True, + document="""Coorfinate system ids to recover used by the + solver. if not set, all available + materials to be recovered.""", + ), + 3: PinSpecification( + name="streams", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data.""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set.""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="coordinate_system_data1", + type_names=["generic_data_container"], + optional=False, + document="""""", + ), + 1: PinSpecification( + name="coordinate_system_data2", + type_names=["generic_data_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config( + name="coordinate_systems_data_provider", server=server + ) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsCoordinateSystemDataProvider + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsCoordinateSystemDataProvider + """ + return super().outputs + + +class InputsCoordinateSystemDataProvider(_Inputs): + """Intermediate class used to connect user inputs to + coordinate_system_data_provider operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + >>> my_solver_coordinate_system_ids = int() + >>> op.inputs.solver_coordinate_system_ids.connect(my_solver_coordinate_system_ids) + >>> my_streams = dpf.StreamsContainer() + >>> op.inputs.streams.connect(my_streams) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + """ + + def __init__(self, op: Operator): + super().__init__(coordinate_system_data_provider._spec().inputs, op) + self._solver_coordinate_system_ids = Input( + coordinate_system_data_provider._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._solver_coordinate_system_ids) + self._streams = Input( + coordinate_system_data_provider._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams) + self._data_sources = Input( + coordinate_system_data_provider._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + + @property + def solver_coordinate_system_ids(self): + """Allows to connect solver_coordinate_system_ids input to the operator. + + Coorfinate system ids to recover used by the + solver. if not set, all available + materials to be recovered. + + Parameters + ---------- + my_solver_coordinate_system_ids : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + >>> op.inputs.solver_coordinate_system_ids.connect(my_solver_coordinate_system_ids) + >>> # or + >>> op.inputs.solver_coordinate_system_ids(my_solver_coordinate_system_ids) + """ + return self._solver_coordinate_system_ids + + @property + def streams(self): + """Allows to connect streams input to the operator. + + Result file container allowed to be kept open + to cache data. + + Parameters + ---------- + my_streams : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + >>> op.inputs.streams.connect(my_streams) + >>> # or + >>> op.inputs.streams(my_streams) + """ + return self._streams + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set. + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + +class OutputsCoordinateSystemDataProvider(_Outputs): + """Intermediate class used to get outputs from + coordinate_system_data_provider operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_coordinate_system_data1 = op.outputs.coordinate_system_data1() + >>> result_coordinate_system_data2 = op.outputs.coordinate_system_data2() + """ + + def __init__(self, op: Operator): + super().__init__(coordinate_system_data_provider._spec().outputs, op) + self._coordinate_system_data1 = Output( + coordinate_system_data_provider._spec().output_pin(0), 0, op + ) + self._outputs.append(self._coordinate_system_data1) + self._coordinate_system_data2 = Output( + coordinate_system_data_provider._spec().output_pin(1), 1, op + ) + self._outputs.append(self._coordinate_system_data2) + + @property + def coordinate_system_data1(self): + """Allows to get coordinate_system_data1 output of the operator + + Returns + ---------- + my_coordinate_system_data1 : GenericDataContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_coordinate_system_data1 = op.outputs.coordinate_system_data1() + """ # noqa: E501 + return self._coordinate_system_data1 + + @property + def coordinate_system_data2(self): + """Allows to get coordinate_system_data2 output of the operator + + Returns + ---------- + my_coordinate_system_data2 : GenericDataContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.coordinate_system_data_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_coordinate_system_data2 = op.outputs.coordinate_system_data2() + """ # noqa: E501 + return self._coordinate_system_data2 diff --git a/src/ansys/dpf/core/operators/metadata/element_types_provider.py b/src/ansys/dpf/core/operators/metadata/element_types_provider.py new file mode 100644 index 00000000000..fd359a72795 --- /dev/null +++ b/src/ansys/dpf/core/operators/metadata/element_types_provider.py @@ -0,0 +1,312 @@ +""" +element_types_provider + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class element_types_provider(Operator): + """Reads element types data from the result files contained in the + streams or data sources. + + Parameters + ---------- + solver_element_types_ids : int, optional + Element type ids to recover used by the + solver. if not set, all available + element types to be recovered. + streams : StreamsContainer, optional + Result file container allowed to be kept open + to cache data. + data_sources : DataSources + Result file path container, used if no + streams are set. + + Returns + ------- + element_types_data : GenericDataContainer + The generic_data_container has a class_name: + elementtypesproperties. it contains + the following property fields: + element_routine_number: element + routine number. e.g 186 for solid186, + keyopts: element type option keys, + kdofs: dof/node for this element + type.this is a bit mapping, nodelm: + number of nodes for this element + type, nodfor: number of nodes per + element having nodal forces, nodstr: + number of nodes per element having + nodal stresses, new_gen_element: + element of new generation. + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.metadata.element_types_provider() + + >>> # Make input connections + >>> my_solver_element_types_ids = int() + >>> op.inputs.solver_element_types_ids.connect(my_solver_element_types_ids) + >>> my_streams = dpf.StreamsContainer() + >>> op.inputs.streams.connect(my_streams) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.metadata.element_types_provider( + ... solver_element_types_ids=my_solver_element_types_ids, + ... streams=my_streams, + ... data_sources=my_data_sources, + ... ) + + >>> # Get output data + >>> result_element_types_data = op.outputs.element_types_data() + """ + + def __init__( + self, + solver_element_types_ids=None, + streams=None, + data_sources=None, + config=None, + server=None, + ): + super().__init__(name="element_types_provider", config=config, server=server) + self._inputs = InputsElementTypesProvider(self) + self._outputs = OutputsElementTypesProvider(self) + if solver_element_types_ids is not None: + self.inputs.solver_element_types_ids.connect(solver_element_types_ids) + if streams is not None: + self.inputs.streams.connect(streams) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + + @staticmethod + def _spec(): + description = """Reads element types data from the result files contained in the + streams or data sources.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 1: PinSpecification( + name="solver_element_types_ids", + type_names=["int32", "vector"], + optional=True, + document="""Element type ids to recover used by the + solver. if not set, all available + element types to be recovered.""", + ), + 3: PinSpecification( + name="streams", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data.""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set.""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="element_types_data", + type_names=["generic_data_container"], + optional=False, + document="""The generic_data_container has a class_name: + elementtypesproperties. it contains + the following property fields: + element_routine_number: element + routine number. e.g 186 for solid186, + keyopts: element type option keys, + kdofs: dof/node for this element + type.this is a bit mapping, nodelm: + number of nodes for this element + type, nodfor: number of nodes per + element having nodal forces, nodstr: + number of nodes per element having + nodal stresses, new_gen_element: + element of new generation.""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="element_types_provider", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsElementTypesProvider + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsElementTypesProvider + """ + return super().outputs + + +class InputsElementTypesProvider(_Inputs): + """Intermediate class used to connect user inputs to + element_types_provider operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.element_types_provider() + >>> my_solver_element_types_ids = int() + >>> op.inputs.solver_element_types_ids.connect(my_solver_element_types_ids) + >>> my_streams = dpf.StreamsContainer() + >>> op.inputs.streams.connect(my_streams) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + """ + + def __init__(self, op: Operator): + super().__init__(element_types_provider._spec().inputs, op) + self._solver_element_types_ids = Input( + element_types_provider._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._solver_element_types_ids) + self._streams = Input(element_types_provider._spec().input_pin(3), 3, op, -1) + self._inputs.append(self._streams) + self._data_sources = Input( + element_types_provider._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + + @property + def solver_element_types_ids(self): + """Allows to connect solver_element_types_ids input to the operator. + + Element type ids to recover used by the + solver. if not set, all available + element types to be recovered. + + Parameters + ---------- + my_solver_element_types_ids : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.element_types_provider() + >>> op.inputs.solver_element_types_ids.connect(my_solver_element_types_ids) + >>> # or + >>> op.inputs.solver_element_types_ids(my_solver_element_types_ids) + """ + return self._solver_element_types_ids + + @property + def streams(self): + """Allows to connect streams input to the operator. + + Result file container allowed to be kept open + to cache data. + + Parameters + ---------- + my_streams : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.element_types_provider() + >>> op.inputs.streams.connect(my_streams) + >>> # or + >>> op.inputs.streams(my_streams) + """ + return self._streams + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set. + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.element_types_provider() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + +class OutputsElementTypesProvider(_Outputs): + """Intermediate class used to get outputs from + element_types_provider operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.element_types_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_element_types_data = op.outputs.element_types_data() + """ + + def __init__(self, op: Operator): + super().__init__(element_types_provider._spec().outputs, op) + self._element_types_data = Output( + element_types_provider._spec().output_pin(0), 0, op + ) + self._outputs.append(self._element_types_data) + + @property + def element_types_data(self): + """Allows to get element_types_data output of the operator + + Returns + ---------- + my_element_types_data : GenericDataContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.element_types_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_element_types_data = op.outputs.element_types_data() + """ # noqa: E501 + return self._element_types_data diff --git a/src/ansys/dpf/core/operators/metadata/real_constants_provider.py b/src/ansys/dpf/core/operators/metadata/real_constants_provider.py new file mode 100644 index 00000000000..78efd6d52c4 --- /dev/null +++ b/src/ansys/dpf/core/operators/metadata/real_constants_provider.py @@ -0,0 +1,315 @@ +""" +real_constants_provider + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class real_constants_provider(Operator): + """Reads real constants from the result files contained in the streams or + data sources. + + Parameters + ---------- + solver_real_constants_ids : int, optional + Real constant ids to recover used by the + solver. if not set, all available + real constants to be recovered. + streams : StreamsContainer, optional + Result file container allowed to be kept open + to cache data. + data_sources : DataSources + Result file path container, used if no + streams are set. + + Returns + ------- + real_constants1 : Field + real_constants2 : Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.metadata.real_constants_provider() + + >>> # Make input connections + >>> my_solver_real_constants_ids = int() + >>> op.inputs.solver_real_constants_ids.connect(my_solver_real_constants_ids) + >>> my_streams = dpf.StreamsContainer() + >>> op.inputs.streams.connect(my_streams) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.metadata.real_constants_provider( + ... solver_real_constants_ids=my_solver_real_constants_ids, + ... streams=my_streams, + ... data_sources=my_data_sources, + ... ) + + >>> # Get output data + >>> result_real_constants1 = op.outputs.real_constants1() + >>> result_real_constants2 = op.outputs.real_constants2() + """ + + def __init__( + self, + solver_real_constants_ids=None, + streams=None, + data_sources=None, + config=None, + server=None, + ): + super().__init__(name="real_constants_provider", config=config, server=server) + self._inputs = InputsRealConstantsProvider(self) + self._outputs = OutputsRealConstantsProvider(self) + if solver_real_constants_ids is not None: + self.inputs.solver_real_constants_ids.connect(solver_real_constants_ids) + if streams is not None: + self.inputs.streams.connect(streams) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + + @staticmethod + def _spec(): + description = """Reads real constants from the result files contained in the streams or + data sources.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 1: PinSpecification( + name="solver_real_constants_ids", + type_names=["int32", "vector"], + optional=True, + document="""Real constant ids to recover used by the + solver. if not set, all available + real constants to be recovered.""", + ), + 3: PinSpecification( + name="streams", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data.""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set.""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="real_constants1", + type_names=["field"], + optional=False, + document="""""", + ), + 1: PinSpecification( + name="real_constants2", + type_names=["field"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="real_constants_provider", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsRealConstantsProvider + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsRealConstantsProvider + """ + return super().outputs + + +class InputsRealConstantsProvider(_Inputs): + """Intermediate class used to connect user inputs to + real_constants_provider operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.real_constants_provider() + >>> my_solver_real_constants_ids = int() + >>> op.inputs.solver_real_constants_ids.connect(my_solver_real_constants_ids) + >>> my_streams = dpf.StreamsContainer() + >>> op.inputs.streams.connect(my_streams) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + """ + + def __init__(self, op: Operator): + super().__init__(real_constants_provider._spec().inputs, op) + self._solver_real_constants_ids = Input( + real_constants_provider._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._solver_real_constants_ids) + self._streams = Input(real_constants_provider._spec().input_pin(3), 3, op, -1) + self._inputs.append(self._streams) + self._data_sources = Input( + real_constants_provider._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + + @property + def solver_real_constants_ids(self): + """Allows to connect solver_real_constants_ids input to the operator. + + Real constant ids to recover used by the + solver. if not set, all available + real constants to be recovered. + + Parameters + ---------- + my_solver_real_constants_ids : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.real_constants_provider() + >>> op.inputs.solver_real_constants_ids.connect(my_solver_real_constants_ids) + >>> # or + >>> op.inputs.solver_real_constants_ids(my_solver_real_constants_ids) + """ + return self._solver_real_constants_ids + + @property + def streams(self): + """Allows to connect streams input to the operator. + + Result file container allowed to be kept open + to cache data. + + Parameters + ---------- + my_streams : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.real_constants_provider() + >>> op.inputs.streams.connect(my_streams) + >>> # or + >>> op.inputs.streams(my_streams) + """ + return self._streams + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set. + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.real_constants_provider() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + +class OutputsRealConstantsProvider(_Outputs): + """Intermediate class used to get outputs from + real_constants_provider operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.real_constants_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_real_constants1 = op.outputs.real_constants1() + >>> result_real_constants2 = op.outputs.real_constants2() + """ + + def __init__(self, op: Operator): + super().__init__(real_constants_provider._spec().outputs, op) + self._real_constants1 = Output( + real_constants_provider._spec().output_pin(0), 0, op + ) + self._outputs.append(self._real_constants1) + self._real_constants2 = Output( + real_constants_provider._spec().output_pin(1), 1, op + ) + self._outputs.append(self._real_constants2) + + @property + def real_constants1(self): + """Allows to get real_constants1 output of the operator + + Returns + ---------- + my_real_constants1 : Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.real_constants_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_real_constants1 = op.outputs.real_constants1() + """ # noqa: E501 + return self._real_constants1 + + @property + def real_constants2(self): + """Allows to get real_constants2 output of the operator + + Returns + ---------- + my_real_constants2 : Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.metadata.real_constants_provider() + >>> # Connect inputs : op.inputs. ... + >>> result_real_constants2 = op.outputs.real_constants2() + """ # noqa: E501 + return self._real_constants2 diff --git a/src/ansys/dpf/core/operators/result/__init__.py b/src/ansys/dpf/core/operators/result/__init__.py index 05261fd0f89..7ea819543e3 100644 --- a/src/ansys/dpf/core/operators/result/__init__.py +++ b/src/ansys/dpf/core/operators/result/__init__.py @@ -99,7 +99,13 @@ from .elastic_strain_YZ import elastic_strain_YZ from .elastic_strain_Z import elastic_strain_Z from .electric_field import electric_field +from .electric_field_X import electric_field_X +from .electric_field_Y import electric_field_Y +from .electric_field_Z import electric_field_Z from .electric_flux_density import electric_flux_density +from .electric_flux_density_X import electric_flux_density_X +from .electric_flux_density_Y import electric_flux_density_Y +from .electric_flux_density_Z import electric_flux_density_Z from .electric_potential import electric_potential from .elemental_heat_generation import elemental_heat_generation from .elemental_mass import elemental_mass @@ -181,7 +187,13 @@ from .kinetic_energy import kinetic_energy from .mach_number import mach_number from .magnetic_field import magnetic_field +from .magnetic_field_X import magnetic_field_X +from .magnetic_field_Y import magnetic_field_Y +from .magnetic_field_Z import magnetic_field_Z from .magnetic_flux_density import magnetic_flux_density +from .magnetic_flux_density_X import magnetic_flux_density_X +from .magnetic_flux_density_Y import magnetic_flux_density_Y +from .magnetic_flux_density_Z import magnetic_flux_density_Z from .magnetic_scalar_potential import magnetic_scalar_potential from .magnetic_vector_potential import magnetic_vector_potential from .mapdl_material_properties import mapdl_material_properties @@ -285,6 +297,9 @@ from .tangential_contact_moment import tangential_contact_moment from .temperature import temperature from .temperature_grad import temperature_grad +from .temperature_grad_X import temperature_grad_X +from .temperature_grad_Y import temperature_grad_Y +from .temperature_grad_Z import temperature_grad_Z from .thermal_conductivity import thermal_conductivity from .thermal_dissipation_energy import thermal_dissipation_energy from .thermal_strain import thermal_strain diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py index 036f09a13c5..f6ecda5a511 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py @@ -12,7 +12,7 @@ class cyclic_expanded_heat_flux(Operator): - """Read mapdl::rth::TF from an rst file and expand it with cyclic + """Read mapdl::rst::TF from an rst file and expand it with cyclic symmetry. Parameters @@ -138,7 +138,7 @@ def __init__( config=None, server=None, ): - super().__init__(name="mapdl::rth::TF_cyclic", config=config, server=server) + super().__init__(name="mapdl::rst::TF_cyclic", config=config, server=server) self._inputs = InputsCyclicExpandedHeatFlux(self) self._outputs = OutputsCyclicExpandedHeatFlux(self) if time_scoping is not None: @@ -172,7 +172,7 @@ def __init__( @staticmethod def _spec(): - description = """Read mapdl::rth::TF from an rst file and expand it with cyclic + description = """Read mapdl::rst::TF from an rst file and expand it with cyclic symmetry.""" spec = Specification( description=description, @@ -303,7 +303,7 @@ def default_config(server=None): Server with channel connected to the remote or local instance. When ``None``, attempts to use the global server. """ - return Operator.default_config(name="mapdl::rth::TF_cyclic", server=server) + return Operator.default_config(name="mapdl::rst::TF_cyclic", server=server) @property def inputs(self): diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py index eca446d9713..efe19cbf06c 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py @@ -137,7 +137,7 @@ def __init__( config=None, server=None, ): - super().__init__(name="mapdl::rth::TEMP_cyclic", config=config, server=server) + super().__init__(name="mapdl::rst::TEMP_cyclic", config=config, server=server) self._inputs = InputsCyclicExpandedTemperature(self) self._outputs = OutputsCyclicExpandedTemperature(self) if time_scoping is not None: @@ -303,7 +303,7 @@ def default_config(server=None): Server with channel connected to the remote or local instance. When ``None``, attempts to use the global server. """ - return Operator.default_config(name="mapdl::rth::TEMP_cyclic", server=server) + return Operator.default_config(name="mapdl::rst::TEMP_cyclic", server=server) @property def inputs(self): diff --git a/src/ansys/dpf/core/operators/result/electric_field_X.py b/src/ansys/dpf/core/operators/result/electric_field_X.py new file mode 100644 index 00000000000..48baca6fa5b --- /dev/null +++ b/src/ansys/dpf/core/operators/result/electric_field_X.py @@ -0,0 +1,653 @@ +""" +electric_field_X + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class electric_field_X(Operator): + """Read/compute electric field X component of the vector (1st component) + by calling the readers defined by the datasources. Regarding the + requested location and the input mesh scoping, the result location + can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.electric_field_X() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.electric_field_X( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="EFX", config=config, server=server) + self._inputs = InputsElectricFieldX(self) + self._outputs = OutputsElectricFieldX(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute electric field X component of the vector (1st component) + by calling the readers defined by the datasources. + Regarding the requested location and the input mesh + scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="EFX", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsElectricFieldX + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsElectricFieldX + """ + return super().outputs + + +class InputsElectricFieldX(_Inputs): + """Intermediate class used to connect user inputs to + electric_field_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(electric_field_X._spec().inputs, op) + self._time_scoping = Input(electric_field_X._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(electric_field_X._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input(electric_field_X._spec().input_pin(2), 2, op, -1) + self._inputs.append(self._fields_container) + self._streams_container = Input( + electric_field_X._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(electric_field_X._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + electric_field_X._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(electric_field_X._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + electric_field_X._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(electric_field_X._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(electric_field_X._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsElectricFieldX(_Outputs): + """Intermediate class used to get outputs from + electric_field_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(electric_field_X._spec().outputs, op) + self._fields_container = Output(electric_field_X._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/electric_field_Y.py b/src/ansys/dpf/core/operators/result/electric_field_Y.py new file mode 100644 index 00000000000..b501ff24fa4 --- /dev/null +++ b/src/ansys/dpf/core/operators/result/electric_field_Y.py @@ -0,0 +1,653 @@ +""" +electric_field_Y + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class electric_field_Y(Operator): + """Read/compute electric field Y component of the vector (2nd component) + by calling the readers defined by the datasources. Regarding the + requested location and the input mesh scoping, the result location + can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.electric_field_Y() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.electric_field_Y( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="EFY", config=config, server=server) + self._inputs = InputsElectricFieldY(self) + self._outputs = OutputsElectricFieldY(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute electric field Y component of the vector (2nd component) + by calling the readers defined by the datasources. + Regarding the requested location and the input mesh + scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="EFY", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsElectricFieldY + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsElectricFieldY + """ + return super().outputs + + +class InputsElectricFieldY(_Inputs): + """Intermediate class used to connect user inputs to + electric_field_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(electric_field_Y._spec().inputs, op) + self._time_scoping = Input(electric_field_Y._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(electric_field_Y._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input(electric_field_Y._spec().input_pin(2), 2, op, -1) + self._inputs.append(self._fields_container) + self._streams_container = Input( + electric_field_Y._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(electric_field_Y._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + electric_field_Y._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(electric_field_Y._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + electric_field_Y._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(electric_field_Y._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(electric_field_Y._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsElectricFieldY(_Outputs): + """Intermediate class used to get outputs from + electric_field_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(electric_field_Y._spec().outputs, op) + self._fields_container = Output(electric_field_Y._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/electric_field_Z.py b/src/ansys/dpf/core/operators/result/electric_field_Z.py new file mode 100644 index 00000000000..0dbc2c6e9f2 --- /dev/null +++ b/src/ansys/dpf/core/operators/result/electric_field_Z.py @@ -0,0 +1,653 @@ +""" +electric_field_Z + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class electric_field_Z(Operator): + """Read/compute electric field Z component of the vector (3rd component) + by calling the readers defined by the datasources. Regarding the + requested location and the input mesh scoping, the result location + can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.electric_field_Z() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.electric_field_Z( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="EFZ", config=config, server=server) + self._inputs = InputsElectricFieldZ(self) + self._outputs = OutputsElectricFieldZ(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute electric field Z component of the vector (3rd component) + by calling the readers defined by the datasources. + Regarding the requested location and the input mesh + scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="EFZ", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsElectricFieldZ + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsElectricFieldZ + """ + return super().outputs + + +class InputsElectricFieldZ(_Inputs): + """Intermediate class used to connect user inputs to + electric_field_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(electric_field_Z._spec().inputs, op) + self._time_scoping = Input(electric_field_Z._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(electric_field_Z._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input(electric_field_Z._spec().input_pin(2), 2, op, -1) + self._inputs.append(self._fields_container) + self._streams_container = Input( + electric_field_Z._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(electric_field_Z._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + electric_field_Z._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(electric_field_Z._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + electric_field_Z._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(electric_field_Z._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(electric_field_Z._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsElectricFieldZ(_Outputs): + """Intermediate class used to get outputs from + electric_field_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(electric_field_Z._spec().outputs, op) + self._fields_container = Output(electric_field_Z._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_field_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density_X.py b/src/ansys/dpf/core/operators/result/electric_flux_density_X.py new file mode 100644 index 00000000000..ecd132ad55a --- /dev/null +++ b/src/ansys/dpf/core/operators/result/electric_flux_density_X.py @@ -0,0 +1,667 @@ +""" +electric_flux_density_X + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class electric_flux_density_X(Operator): + """Read/compute Electric flux density X component of the vector (1st + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.electric_flux_density_X() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.electric_flux_density_X( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="EFDX", config=config, server=server) + self._inputs = InputsElectricFluxDensityX(self) + self._outputs = OutputsElectricFluxDensityX(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Electric flux density X component of the vector (1st + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="EFDX", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsElectricFluxDensityX + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsElectricFluxDensityX + """ + return super().outputs + + +class InputsElectricFluxDensityX(_Inputs): + """Intermediate class used to connect user inputs to + electric_flux_density_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(electric_flux_density_X._spec().inputs, op) + self._time_scoping = Input( + electric_flux_density_X._spec().input_pin(0), 0, op, -1 + ) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input( + electric_flux_density_X._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + electric_flux_density_X._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + electric_flux_density_X._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input( + electric_flux_density_X._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + electric_flux_density_X._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(electric_flux_density_X._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + electric_flux_density_X._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input( + electric_flux_density_X._spec().input_pin(14), 14, op, -1 + ) + self._inputs.append(self._read_cyclic) + self._read_beams = Input( + electric_flux_density_X._spec().input_pin(22), 22, op, -1 + ) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsElectricFluxDensityX(_Outputs): + """Intermediate class used to get outputs from + electric_flux_density_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(electric_flux_density_X._spec().outputs, op) + self._fields_container = Output( + electric_flux_density_X._spec().output_pin(0), 0, op + ) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density_Y.py b/src/ansys/dpf/core/operators/result/electric_flux_density_Y.py new file mode 100644 index 00000000000..4d0c69a5b0d --- /dev/null +++ b/src/ansys/dpf/core/operators/result/electric_flux_density_Y.py @@ -0,0 +1,667 @@ +""" +electric_flux_density_Y + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class electric_flux_density_Y(Operator): + """Read/compute Electric flux density Y component of the vector (2nd + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.electric_flux_density_Y() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.electric_flux_density_Y( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="EFDY", config=config, server=server) + self._inputs = InputsElectricFluxDensityY(self) + self._outputs = OutputsElectricFluxDensityY(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Electric flux density Y component of the vector (2nd + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="EFDY", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsElectricFluxDensityY + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsElectricFluxDensityY + """ + return super().outputs + + +class InputsElectricFluxDensityY(_Inputs): + """Intermediate class used to connect user inputs to + electric_flux_density_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(electric_flux_density_Y._spec().inputs, op) + self._time_scoping = Input( + electric_flux_density_Y._spec().input_pin(0), 0, op, -1 + ) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input( + electric_flux_density_Y._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + electric_flux_density_Y._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + electric_flux_density_Y._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input( + electric_flux_density_Y._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + electric_flux_density_Y._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(electric_flux_density_Y._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + electric_flux_density_Y._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input( + electric_flux_density_Y._spec().input_pin(14), 14, op, -1 + ) + self._inputs.append(self._read_cyclic) + self._read_beams = Input( + electric_flux_density_Y._spec().input_pin(22), 22, op, -1 + ) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsElectricFluxDensityY(_Outputs): + """Intermediate class used to get outputs from + electric_flux_density_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(electric_flux_density_Y._spec().outputs, op) + self._fields_container = Output( + electric_flux_density_Y._spec().output_pin(0), 0, op + ) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density_Z.py b/src/ansys/dpf/core/operators/result/electric_flux_density_Z.py new file mode 100644 index 00000000000..0e0be41756d --- /dev/null +++ b/src/ansys/dpf/core/operators/result/electric_flux_density_Z.py @@ -0,0 +1,667 @@ +""" +electric_flux_density_Z + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class electric_flux_density_Z(Operator): + """Read/compute Electric flux density Z component of the vector (3rd + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.electric_flux_density_Z() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.electric_flux_density_Z( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="EFDZ", config=config, server=server) + self._inputs = InputsElectricFluxDensityZ(self) + self._outputs = OutputsElectricFluxDensityZ(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Electric flux density Z component of the vector (3rd + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="EFDZ", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsElectricFluxDensityZ + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsElectricFluxDensityZ + """ + return super().outputs + + +class InputsElectricFluxDensityZ(_Inputs): + """Intermediate class used to connect user inputs to + electric_flux_density_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(electric_flux_density_Z._spec().inputs, op) + self._time_scoping = Input( + electric_flux_density_Z._spec().input_pin(0), 0, op, -1 + ) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input( + electric_flux_density_Z._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + electric_flux_density_Z._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + electric_flux_density_Z._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input( + electric_flux_density_Z._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + electric_flux_density_Z._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(electric_flux_density_Z._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + electric_flux_density_Z._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input( + electric_flux_density_Z._spec().input_pin(14), 14, op, -1 + ) + self._inputs.append(self._read_cyclic) + self._read_beams = Input( + electric_flux_density_Z._spec().input_pin(22), 22, op, -1 + ) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsElectricFluxDensityZ(_Outputs): + """Intermediate class used to get outputs from + electric_flux_density_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(electric_flux_density_Z._spec().outputs, op) + self._fields_container = Output( + electric_flux_density_Z._spec().output_pin(0), 0, op + ) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.electric_flux_density_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/magnetic_field_X.py b/src/ansys/dpf/core/operators/result/magnetic_field_X.py new file mode 100644 index 00000000000..97131fb60f3 --- /dev/null +++ b/src/ansys/dpf/core/operators/result/magnetic_field_X.py @@ -0,0 +1,653 @@ +""" +magnetic_field_X + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class magnetic_field_X(Operator): + """Read/compute Magnetic Field X component of the vector (1st component) + by calling the readers defined by the datasources. Regarding the + requested location and the input mesh scoping, the result location + can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.magnetic_field_X() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.magnetic_field_X( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="MFX", config=config, server=server) + self._inputs = InputsMagneticFieldX(self) + self._outputs = OutputsMagneticFieldX(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Magnetic Field X component of the vector (1st component) + by calling the readers defined by the datasources. + Regarding the requested location and the input mesh + scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="MFX", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsMagneticFieldX + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsMagneticFieldX + """ + return super().outputs + + +class InputsMagneticFieldX(_Inputs): + """Intermediate class used to connect user inputs to + magnetic_field_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_field_X._spec().inputs, op) + self._time_scoping = Input(magnetic_field_X._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(magnetic_field_X._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input(magnetic_field_X._spec().input_pin(2), 2, op, -1) + self._inputs.append(self._fields_container) + self._streams_container = Input( + magnetic_field_X._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(magnetic_field_X._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + magnetic_field_X._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(magnetic_field_X._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + magnetic_field_X._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(magnetic_field_X._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(magnetic_field_X._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsMagneticFieldX(_Outputs): + """Intermediate class used to get outputs from + magnetic_field_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_field_X._spec().outputs, op) + self._fields_container = Output(magnetic_field_X._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/magnetic_field_Y.py b/src/ansys/dpf/core/operators/result/magnetic_field_Y.py new file mode 100644 index 00000000000..76f61b74c1a --- /dev/null +++ b/src/ansys/dpf/core/operators/result/magnetic_field_Y.py @@ -0,0 +1,653 @@ +""" +magnetic_field_Y + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class magnetic_field_Y(Operator): + """Read/compute Magnetic Field Y component of the vector (2nd component) + by calling the readers defined by the datasources. Regarding the + requested location and the input mesh scoping, the result location + can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.magnetic_field_Y() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.magnetic_field_Y( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="MFY", config=config, server=server) + self._inputs = InputsMagneticFieldY(self) + self._outputs = OutputsMagneticFieldY(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Magnetic Field Y component of the vector (2nd component) + by calling the readers defined by the datasources. + Regarding the requested location and the input mesh + scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="MFY", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsMagneticFieldY + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsMagneticFieldY + """ + return super().outputs + + +class InputsMagneticFieldY(_Inputs): + """Intermediate class used to connect user inputs to + magnetic_field_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_field_Y._spec().inputs, op) + self._time_scoping = Input(magnetic_field_Y._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(magnetic_field_Y._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input(magnetic_field_Y._spec().input_pin(2), 2, op, -1) + self._inputs.append(self._fields_container) + self._streams_container = Input( + magnetic_field_Y._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(magnetic_field_Y._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + magnetic_field_Y._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(magnetic_field_Y._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + magnetic_field_Y._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(magnetic_field_Y._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(magnetic_field_Y._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsMagneticFieldY(_Outputs): + """Intermediate class used to get outputs from + magnetic_field_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_field_Y._spec().outputs, op) + self._fields_container = Output(magnetic_field_Y._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/magnetic_field_Z.py b/src/ansys/dpf/core/operators/result/magnetic_field_Z.py new file mode 100644 index 00000000000..996c1ac01cb --- /dev/null +++ b/src/ansys/dpf/core/operators/result/magnetic_field_Z.py @@ -0,0 +1,653 @@ +""" +magnetic_field_Z + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class magnetic_field_Z(Operator): + """Read/compute Magnetic Field Z component of the vector (3rd component) + by calling the readers defined by the datasources. Regarding the + requested location and the input mesh scoping, the result location + can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.magnetic_field_Z() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.magnetic_field_Z( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="MFZ", config=config, server=server) + self._inputs = InputsMagneticFieldZ(self) + self._outputs = OutputsMagneticFieldZ(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Magnetic Field Z component of the vector (3rd component) + by calling the readers defined by the datasources. + Regarding the requested location and the input mesh + scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="MFZ", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsMagneticFieldZ + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsMagneticFieldZ + """ + return super().outputs + + +class InputsMagneticFieldZ(_Inputs): + """Intermediate class used to connect user inputs to + magnetic_field_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_field_Z._spec().inputs, op) + self._time_scoping = Input(magnetic_field_Z._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(magnetic_field_Z._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input(magnetic_field_Z._spec().input_pin(2), 2, op, -1) + self._inputs.append(self._fields_container) + self._streams_container = Input( + magnetic_field_Z._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(magnetic_field_Z._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + magnetic_field_Z._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(magnetic_field_Z._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + magnetic_field_Z._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(magnetic_field_Z._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(magnetic_field_Z._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsMagneticFieldZ(_Outputs): + """Intermediate class used to get outputs from + magnetic_field_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_field_Z._spec().outputs, op) + self._fields_container = Output(magnetic_field_Z._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_field_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density_X.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density_X.py new file mode 100644 index 00000000000..481d3ee4590 --- /dev/null +++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density_X.py @@ -0,0 +1,667 @@ +""" +magnetic_flux_density_X + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class magnetic_flux_density_X(Operator): + """Read/compute Magnetic Flux Density X component of the vector (1st + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.magnetic_flux_density_X() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.magnetic_flux_density_X( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="MFDX", config=config, server=server) + self._inputs = InputsMagneticFluxDensityX(self) + self._outputs = OutputsMagneticFluxDensityX(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Magnetic Flux Density X component of the vector (1st + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="MFDX", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsMagneticFluxDensityX + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsMagneticFluxDensityX + """ + return super().outputs + + +class InputsMagneticFluxDensityX(_Inputs): + """Intermediate class used to connect user inputs to + magnetic_flux_density_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_flux_density_X._spec().inputs, op) + self._time_scoping = Input( + magnetic_flux_density_X._spec().input_pin(0), 0, op, -1 + ) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input( + magnetic_flux_density_X._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + magnetic_flux_density_X._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + magnetic_flux_density_X._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input( + magnetic_flux_density_X._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + magnetic_flux_density_X._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(magnetic_flux_density_X._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + magnetic_flux_density_X._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input( + magnetic_flux_density_X._spec().input_pin(14), 14, op, -1 + ) + self._inputs.append(self._read_cyclic) + self._read_beams = Input( + magnetic_flux_density_X._spec().input_pin(22), 22, op, -1 + ) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsMagneticFluxDensityX(_Outputs): + """Intermediate class used to get outputs from + magnetic_flux_density_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_flux_density_X._spec().outputs, op) + self._fields_container = Output( + magnetic_flux_density_X._spec().output_pin(0), 0, op + ) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density_Y.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Y.py new file mode 100644 index 00000000000..b99d0f82e2e --- /dev/null +++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Y.py @@ -0,0 +1,667 @@ +""" +magnetic_flux_density_Y + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class magnetic_flux_density_Y(Operator): + """Read/compute Magnetic Flux Density Y component of the vector (2nd + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.magnetic_flux_density_Y() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.magnetic_flux_density_Y( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="MFDY", config=config, server=server) + self._inputs = InputsMagneticFluxDensityY(self) + self._outputs = OutputsMagneticFluxDensityY(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Magnetic Flux Density Y component of the vector (2nd + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="MFDY", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsMagneticFluxDensityY + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsMagneticFluxDensityY + """ + return super().outputs + + +class InputsMagneticFluxDensityY(_Inputs): + """Intermediate class used to connect user inputs to + magnetic_flux_density_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_flux_density_Y._spec().inputs, op) + self._time_scoping = Input( + magnetic_flux_density_Y._spec().input_pin(0), 0, op, -1 + ) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input( + magnetic_flux_density_Y._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + magnetic_flux_density_Y._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + magnetic_flux_density_Y._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input( + magnetic_flux_density_Y._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + magnetic_flux_density_Y._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(magnetic_flux_density_Y._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + magnetic_flux_density_Y._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input( + magnetic_flux_density_Y._spec().input_pin(14), 14, op, -1 + ) + self._inputs.append(self._read_cyclic) + self._read_beams = Input( + magnetic_flux_density_Y._spec().input_pin(22), 22, op, -1 + ) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsMagneticFluxDensityY(_Outputs): + """Intermediate class used to get outputs from + magnetic_flux_density_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_flux_density_Y._spec().outputs, op) + self._fields_container = Output( + magnetic_flux_density_Y._spec().output_pin(0), 0, op + ) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density_Z.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Z.py new file mode 100644 index 00000000000..075217ae303 --- /dev/null +++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Z.py @@ -0,0 +1,667 @@ +""" +magnetic_flux_density_Z + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class magnetic_flux_density_Z(Operator): + """Read/compute Magnetic Flux Density Z component of the vector (3rd + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.magnetic_flux_density_Z() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.magnetic_flux_density_Z( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="MFDZ", config=config, server=server) + self._inputs = InputsMagneticFluxDensityZ(self) + self._outputs = OutputsMagneticFluxDensityZ(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Magnetic Flux Density Z component of the vector (3rd + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="MFDZ", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsMagneticFluxDensityZ + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsMagneticFluxDensityZ + """ + return super().outputs + + +class InputsMagneticFluxDensityZ(_Inputs): + """Intermediate class used to connect user inputs to + magnetic_flux_density_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_flux_density_Z._spec().inputs, op) + self._time_scoping = Input( + magnetic_flux_density_Z._spec().input_pin(0), 0, op, -1 + ) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input( + magnetic_flux_density_Z._spec().input_pin(1), 1, op, -1 + ) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + magnetic_flux_density_Z._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + magnetic_flux_density_Z._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input( + magnetic_flux_density_Z._spec().input_pin(4), 4, op, -1 + ) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + magnetic_flux_density_Z._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(magnetic_flux_density_Z._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + magnetic_flux_density_Z._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input( + magnetic_flux_density_Z._spec().input_pin(14), 14, op, -1 + ) + self._inputs.append(self._read_cyclic) + self._read_beams = Input( + magnetic_flux_density_Z._spec().input_pin(22), 22, op, -1 + ) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsMagneticFluxDensityZ(_Outputs): + """Intermediate class used to get outputs from + magnetic_flux_density_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(magnetic_flux_density_Z._spec().outputs, op) + self._fields_container = Output( + magnetic_flux_density_Z._spec().output_pin(0), 0, op + ) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.magnetic_flux_density_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/temperature_grad_X.py b/src/ansys/dpf/core/operators/result/temperature_grad_X.py new file mode 100644 index 00000000000..cd778e776fc --- /dev/null +++ b/src/ansys/dpf/core/operators/result/temperature_grad_X.py @@ -0,0 +1,655 @@ +""" +temperature_grad_X + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class temperature_grad_X(Operator): + """Read/compute Temperature Gradient X component of the vector (1st + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.temperature_grad_X() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.temperature_grad_X( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="TGX", config=config, server=server) + self._inputs = InputsTemperatureGradX(self) + self._outputs = OutputsTemperatureGradX(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Temperature Gradient X component of the vector (1st + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="TGX", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsTemperatureGradX + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsTemperatureGradX + """ + return super().outputs + + +class InputsTemperatureGradX(_Inputs): + """Intermediate class used to connect user inputs to + temperature_grad_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(temperature_grad_X._spec().inputs, op) + self._time_scoping = Input(temperature_grad_X._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(temperature_grad_X._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + temperature_grad_X._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + temperature_grad_X._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(temperature_grad_X._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + temperature_grad_X._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(temperature_grad_X._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + temperature_grad_X._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(temperature_grad_X._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(temperature_grad_X._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsTemperatureGradX(_Outputs): + """Intermediate class used to get outputs from + temperature_grad_X operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(temperature_grad_X._spec().outputs, op) + self._fields_container = Output(temperature_grad_X._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_X() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/temperature_grad_Y.py b/src/ansys/dpf/core/operators/result/temperature_grad_Y.py new file mode 100644 index 00000000000..d1affd4fd21 --- /dev/null +++ b/src/ansys/dpf/core/operators/result/temperature_grad_Y.py @@ -0,0 +1,655 @@ +""" +temperature_grad_Y + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class temperature_grad_Y(Operator): + """Read/compute Temperature Gradient Y component of the vector (2nd + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.temperature_grad_Y() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.temperature_grad_Y( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="TGY", config=config, server=server) + self._inputs = InputsTemperatureGradY(self) + self._outputs = OutputsTemperatureGradY(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Temperature Gradient Y component of the vector (2nd + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="TGY", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsTemperatureGradY + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsTemperatureGradY + """ + return super().outputs + + +class InputsTemperatureGradY(_Inputs): + """Intermediate class used to connect user inputs to + temperature_grad_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(temperature_grad_Y._spec().inputs, op) + self._time_scoping = Input(temperature_grad_Y._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(temperature_grad_Y._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + temperature_grad_Y._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + temperature_grad_Y._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(temperature_grad_Y._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + temperature_grad_Y._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(temperature_grad_Y._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + temperature_grad_Y._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(temperature_grad_Y._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(temperature_grad_Y._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsTemperatureGradY(_Outputs): + """Intermediate class used to get outputs from + temperature_grad_Y operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(temperature_grad_Y._spec().outputs, op) + self._fields_container = Output(temperature_grad_Y._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Y() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/core/operators/result/temperature_grad_Z.py b/src/ansys/dpf/core/operators/result/temperature_grad_Z.py new file mode 100644 index 00000000000..76961e47634 --- /dev/null +++ b/src/ansys/dpf/core/operators/result/temperature_grad_Z.py @@ -0,0 +1,655 @@ +""" +temperature_grad_Z + +Autogenerated DPF operator classes. +""" + +from warnings import warn +from ansys.dpf.core.dpf_operator import Operator +from ansys.dpf.core.inputs import Input, _Inputs +from ansys.dpf.core.outputs import Output, _Outputs +from ansys.dpf.core.operators.specification import PinSpecification, Specification + + +class temperature_grad_Z(Operator): + """Read/compute Temperature Gradient Z component of the vector (3rd + component) by calling the readers defined by the datasources. + Regarding the requested location and the input mesh scoping, the + result location can be Nodal/ElementalNodal/Elemental. + + Parameters + ---------- + time_scoping : Scoping or int or float or Field, optional + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + mesh_scoping : ScopingsContainer or Scoping, optional + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + fields_container : FieldsContainer, optional + Fieldscontainer already allocated modified + inplace + streams_container : StreamsContainer, optional + Result file container allowed to be kept open + to cache data + data_sources : DataSources + Result file path container, used if no + streams are set + bool_rotate_to_global : bool, optional + If true the field is rotated to global + coordinate system (default true) + mesh : MeshedRegion or MeshesContainer, optional + Prevents from reading the mesh in the result + files + requested_location : str, optional + Requested location, default is nodal + read_cyclic : int, optional + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + read_beams : bool, optional + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Returns + ------- + fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + + >>> # Instantiate operator + >>> op = dpf.operators.result.temperature_grad_Z() + + >>> # Make input connections + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + + >>> # Instantiate operator and connect inputs in one line + >>> op = dpf.operators.result.temperature_grad_Z( + ... time_scoping=my_time_scoping, + ... mesh_scoping=my_mesh_scoping, + ... fields_container=my_fields_container, + ... streams_container=my_streams_container, + ... data_sources=my_data_sources, + ... bool_rotate_to_global=my_bool_rotate_to_global, + ... mesh=my_mesh, + ... requested_location=my_requested_location, + ... read_cyclic=my_read_cyclic, + ... read_beams=my_read_beams, + ... ) + + >>> # Get output data + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__( + self, + time_scoping=None, + mesh_scoping=None, + fields_container=None, + streams_container=None, + data_sources=None, + bool_rotate_to_global=None, + mesh=None, + requested_location=None, + read_cyclic=None, + read_beams=None, + config=None, + server=None, + ): + super().__init__(name="TGZ", config=config, server=server) + self._inputs = InputsTemperatureGradZ(self) + self._outputs = OutputsTemperatureGradZ(self) + if time_scoping is not None: + self.inputs.time_scoping.connect(time_scoping) + if mesh_scoping is not None: + self.inputs.mesh_scoping.connect(mesh_scoping) + if fields_container is not None: + self.inputs.fields_container.connect(fields_container) + if streams_container is not None: + self.inputs.streams_container.connect(streams_container) + if data_sources is not None: + self.inputs.data_sources.connect(data_sources) + if bool_rotate_to_global is not None: + self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global) + if mesh is not None: + self.inputs.mesh.connect(mesh) + if requested_location is not None: + self.inputs.requested_location.connect(requested_location) + if read_cyclic is not None: + self.inputs.read_cyclic.connect(read_cyclic) + if read_beams is not None: + self.inputs.read_beams.connect(read_beams) + + @staticmethod + def _spec(): + description = """Read/compute Temperature Gradient Z component of the vector (3rd + component) by calling the readers defined by the + datasources. Regarding the requested location and the + input mesh scoping, the result location can be + Nodal/ElementalNodal/Elemental.""" + spec = Specification( + description=description, + map_input_pin_spec={ + 0: PinSpecification( + name="time_scoping", + type_names=[ + "scoping", + "int32", + "vector", + "double", + "field", + "vector", + ], + optional=True, + document="""Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files.""", + ), + 1: PinSpecification( + name="mesh_scoping", + type_names=["scopings_container", "scoping"], + optional=True, + document="""Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains""", + ), + 2: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=True, + document="""Fieldscontainer already allocated modified + inplace""", + ), + 3: PinSpecification( + name="streams_container", + type_names=["streams_container"], + optional=True, + document="""Result file container allowed to be kept open + to cache data""", + ), + 4: PinSpecification( + name="data_sources", + type_names=["data_sources"], + optional=False, + document="""Result file path container, used if no + streams are set""", + ), + 5: PinSpecification( + name="bool_rotate_to_global", + type_names=["bool"], + optional=True, + document="""If true the field is rotated to global + coordinate system (default true)""", + ), + 7: PinSpecification( + name="mesh", + type_names=["abstract_meshed_region", "meshes_container"], + optional=True, + document="""Prevents from reading the mesh in the result + files""", + ), + 9: PinSpecification( + name="requested_location", + type_names=["string"], + optional=True, + document="""Requested location, default is nodal""", + ), + 14: PinSpecification( + name="read_cyclic", + type_names=["enum dataProcessing::ECyclicReading", "int32"], + optional=True, + document="""If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1)""", + ), + 22: PinSpecification( + name="read_beams", + type_names=["bool"], + optional=True, + document="""Elemental nodal beam results are read if this + pin is set to true (default is false)""", + ), + }, + map_output_pin_spec={ + 0: PinSpecification( + name="fields_container", + type_names=["fields_container"], + optional=False, + document="""""", + ), + }, + ) + return spec + + @staticmethod + def default_config(server=None): + """Returns the default config of the operator. + + This config can then be changed to the user needs and be used to + instantiate the operator. The Configuration allows to customize + how the operation will be processed by the operator. + + Parameters + ---------- + server : server.DPFServer, optional + Server with channel connected to the remote or local instance. When + ``None``, attempts to use the global server. + """ + return Operator.default_config(name="TGZ", server=server) + + @property + def inputs(self): + """Enables to connect inputs to the operator + + Returns + -------- + inputs : InputsTemperatureGradZ + """ + return super().inputs + + @property + def outputs(self): + """Enables to get outputs of the operator by evaluating it + + Returns + -------- + outputs : OutputsTemperatureGradZ + """ + return super().outputs + + +class InputsTemperatureGradZ(_Inputs): + """Intermediate class used to connect user inputs to + temperature_grad_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> my_time_scoping = dpf.Scoping() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> my_mesh_scoping = dpf.ScopingsContainer() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> my_fields_container = dpf.FieldsContainer() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> my_streams_container = dpf.StreamsContainer() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> my_data_sources = dpf.DataSources() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> my_bool_rotate_to_global = bool() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> my_mesh = dpf.MeshedRegion() + >>> op.inputs.mesh.connect(my_mesh) + >>> my_requested_location = str() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> my_read_cyclic = int() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> my_read_beams = bool() + >>> op.inputs.read_beams.connect(my_read_beams) + """ + + def __init__(self, op: Operator): + super().__init__(temperature_grad_Z._spec().inputs, op) + self._time_scoping = Input(temperature_grad_Z._spec().input_pin(0), 0, op, -1) + self._inputs.append(self._time_scoping) + self._mesh_scoping = Input(temperature_grad_Z._spec().input_pin(1), 1, op, -1) + self._inputs.append(self._mesh_scoping) + self._fields_container = Input( + temperature_grad_Z._spec().input_pin(2), 2, op, -1 + ) + self._inputs.append(self._fields_container) + self._streams_container = Input( + temperature_grad_Z._spec().input_pin(3), 3, op, -1 + ) + self._inputs.append(self._streams_container) + self._data_sources = Input(temperature_grad_Z._spec().input_pin(4), 4, op, -1) + self._inputs.append(self._data_sources) + self._bool_rotate_to_global = Input( + temperature_grad_Z._spec().input_pin(5), 5, op, -1 + ) + self._inputs.append(self._bool_rotate_to_global) + self._mesh = Input(temperature_grad_Z._spec().input_pin(7), 7, op, -1) + self._inputs.append(self._mesh) + self._requested_location = Input( + temperature_grad_Z._spec().input_pin(9), 9, op, -1 + ) + self._inputs.append(self._requested_location) + self._read_cyclic = Input(temperature_grad_Z._spec().input_pin(14), 14, op, -1) + self._inputs.append(self._read_cyclic) + self._read_beams = Input(temperature_grad_Z._spec().input_pin(22), 22, op, -1) + self._inputs.append(self._read_beams) + + @property + def time_scoping(self): + """Allows to connect time_scoping input to the operator. + + Time/freq values (use doubles or field), + time/freq set ids (use ints or + scoping) or time/freq step ids (use + scoping with timefreq_steps location) + required in output. to specify + time/freq values at specific load + steps, put a field (and not a list) + in input with a scoping located on + "timefreq_steps". linear time freq + intrapolation is performed if the + values are not in the result files + and the data at the max time or freq + is taken when time/freqs are higher + than available time/freqs in result + files. + + Parameters + ---------- + my_time_scoping : Scoping or int or float or Field + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.time_scoping.connect(my_time_scoping) + >>> # or + >>> op.inputs.time_scoping(my_time_scoping) + """ + return self._time_scoping + + @property + def mesh_scoping(self): + """Allows to connect mesh_scoping input to the operator. + + Nodes or elements scoping required in output. + the output fields will be scoped on + these node or element ids. to figure + out the ordering of the fields data, + look at their scoping ids as they + might not be ordered as the input + scoping was. the scoping's location + indicates whether nodes or elements + are asked for. using scopings + container allows you to split the + result fields container into domains + + Parameters + ---------- + my_mesh_scoping : ScopingsContainer or Scoping + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.mesh_scoping.connect(my_mesh_scoping) + >>> # or + >>> op.inputs.mesh_scoping(my_mesh_scoping) + """ + return self._mesh_scoping + + @property + def fields_container(self): + """Allows to connect fields_container input to the operator. + + Fieldscontainer already allocated modified + inplace + + Parameters + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.fields_container.connect(my_fields_container) + >>> # or + >>> op.inputs.fields_container(my_fields_container) + """ + return self._fields_container + + @property + def streams_container(self): + """Allows to connect streams_container input to the operator. + + Result file container allowed to be kept open + to cache data + + Parameters + ---------- + my_streams_container : StreamsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.streams_container.connect(my_streams_container) + >>> # or + >>> op.inputs.streams_container(my_streams_container) + """ + return self._streams_container + + @property + def data_sources(self): + """Allows to connect data_sources input to the operator. + + Result file path container, used if no + streams are set + + Parameters + ---------- + my_data_sources : DataSources + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.data_sources.connect(my_data_sources) + >>> # or + >>> op.inputs.data_sources(my_data_sources) + """ + return self._data_sources + + @property + def bool_rotate_to_global(self): + """Allows to connect bool_rotate_to_global input to the operator. + + If true the field is rotated to global + coordinate system (default true) + + Parameters + ---------- + my_bool_rotate_to_global : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) + >>> # or + >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global) + """ + return self._bool_rotate_to_global + + @property + def mesh(self): + """Allows to connect mesh input to the operator. + + Prevents from reading the mesh in the result + files + + Parameters + ---------- + my_mesh : MeshedRegion or MeshesContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.mesh.connect(my_mesh) + >>> # or + >>> op.inputs.mesh(my_mesh) + """ + return self._mesh + + @property + def requested_location(self): + """Allows to connect requested_location input to the operator. + + Requested location, default is nodal + + Parameters + ---------- + my_requested_location : str + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.requested_location.connect(my_requested_location) + >>> # or + >>> op.inputs.requested_location(my_requested_location) + """ + return self._requested_location + + @property + def read_cyclic(self): + """Allows to connect read_cyclic input to the operator. + + If 0 cyclic symmetry is ignored, if 1 cyclic + sector is read, if 2 cyclic expansion + is done, if 3 cyclic expansion is + done and stages are merged (default + is 1) + + Parameters + ---------- + my_read_cyclic : int + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.read_cyclic.connect(my_read_cyclic) + >>> # or + >>> op.inputs.read_cyclic(my_read_cyclic) + """ + return self._read_cyclic + + @property + def read_beams(self): + """Allows to connect read_beams input to the operator. + + Elemental nodal beam results are read if this + pin is set to true (default is false) + + Parameters + ---------- + my_read_beams : bool + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> op.inputs.read_beams.connect(my_read_beams) + >>> # or + >>> op.inputs.read_beams(my_read_beams) + """ + return self._read_beams + + +class OutputsTemperatureGradZ(_Outputs): + """Intermediate class used to get outputs from + temperature_grad_Z operator. + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ + + def __init__(self, op: Operator): + super().__init__(temperature_grad_Z._spec().outputs, op) + self._fields_container = Output(temperature_grad_Z._spec().output_pin(0), 0, op) + self._outputs.append(self._fields_container) + + @property + def fields_container(self): + """Allows to get fields_container output of the operator + + Returns + ---------- + my_fields_container : FieldsContainer + + Examples + -------- + >>> from ansys.dpf import core as dpf + >>> op = dpf.operators.result.temperature_grad_Z() + >>> # Connect inputs : op.inputs. ... + >>> result_fields_container = op.outputs.fields_container() + """ # noqa: E501 + return self._fields_container diff --git a/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll b/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll index d4ec333117e..1642ab0bc3a 100644 Binary files a/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll and b/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll differ diff --git a/src/ansys/dpf/gatebin/DPFClientAPI.dll b/src/ansys/dpf/gatebin/DPFClientAPI.dll index f10bba2bc78..a24b49b1f03 100644 Binary files a/src/ansys/dpf/gatebin/DPFClientAPI.dll and b/src/ansys/dpf/gatebin/DPFClientAPI.dll differ diff --git a/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so b/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so index 16a31ed831c..e9180db793e 100644 Binary files a/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so and b/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so differ diff --git a/src/ansys/dpf/gatebin/libDPFClientAPI.so b/src/ansys/dpf/gatebin/libDPFClientAPI.so index 66373788843..63de951a04b 100644 Binary files a/src/ansys/dpf/gatebin/libDPFClientAPI.so and b/src/ansys/dpf/gatebin/libDPFClientAPI.so differ diff --git a/src/ansys/grpc/dpf/dpf_any_pb2.py b/src/ansys/grpc/dpf/dpf_any_pb2.py index bbddc5ddd1d..26cd3c1bcb2 100644 --- a/src/ansys/grpc/dpf/dpf_any_pb2.py +++ b/src/ansys/grpc/dpf/dpf_any_pb2.py @@ -28,7 +28,7 @@ import ansys.grpc.dpf.data_tree_pb2 as data__tree__pb2 -DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rdpf_any.proto\x12\x18\x61nsys.api.dpf.dpf_any.v0\x1a\nbase.proto\x1a\x15\x64pf_any_message.proto\x1a\x10\x63ollection.proto\x1a\x0b\x66ield.proto\x1a\rscoping.proto\x1a\x12\x64\x61ta_sources.proto\x1a\x13meshed_region.proto\x1a\x17time_freq_support.proto\x1a\x14\x63yclic_support.proto\x1a\x16workflow_message.proto\x1a\x11result_info.proto\x1a\x0eoperator.proto\x1a\x1cgeneric_data_container.proto\x1a\x0f\x64\x61ta_tree.proto\"$\n\x0cListResponse\x12\x14\n\x0cwrapped_type\x18\x01 \x01(\t\"\\\n\x0bTypeRequest\x12\x35\n\x03\x61ny\x18\x01 \x01(\x0b\x32(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x12\x16\n\x0erequested_type\x18\x02 \x01(\t\"\"\n\x0cTypeResponse\x12\x12\n\nis_type_of\x18\x01 \x01(\x08\"\x9e\x01\n\x0cGetAsRequest\x12\x35\n\x03\x61ny\x18\x01 \x01(\x0b\x32(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x12)\n\x04type\x18\x02 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\x12,\n\x07subtype\x18\x03 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\"\xf1\x06\n\rGetAsResponse\x12.\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x1d.ansys.api.dpf.field.v0.FieldH\x00\x12=\n\ncollection\x18\x02 \x01(\x0b\x32\'.ansys.api.dpf.collection.v0.CollectionH\x00\x12\x34\n\x07scoping\x18\x03 \x01(\x0b\x32!.ansys.api.dpf.scoping.v0.ScopingH\x00\x12\x42\n\x0c\x64\x61ta_sources\x18\x04 \x01(\x0b\x32*.ansys.api.dpf.data_sources.v0.DataSourcesH\x00\x12<\n\x04mesh\x18\x05 \x01(\x0b\x32,.ansys.api.dpf.meshed_region.v0.MeshedRegionH\x00\x12\x45\n\x0b\x63yc_support\x18\x06 \x01(\x0b\x32..ansys.api.dpf.cyclic_support.v0.CyclicSupportH\x00\x12P\n\x11time_freq_support\x18\x07 \x01(\x0b\x32\x33.ansys.api.dpf.time_freq_support.v0.TimeFreqSupportH\x00\x12?\n\x08workflow\x18\x08 \x01(\x0b\x32+.ansys.api.dpf.workflow_message.v0.WorkflowH\x00\x12;\n\x08operator\x18\t \x01(\x0b\x32\'.ansys.api.dpf.dpf_operator.v0.OperatorH\x00\x12?\n\x0bresult_info\x18\n \x01(\x0b\x32(.ansys.api.dpf.result_info.v0.ResultInfoH\x00\x12_\n\x16generic_data_container\x18\x0b \x01(\x0b\x32=.ansys.api.dpf.generic_data_container.v0.GenericDataContainerH\x00\x12\x39\n\tdata_tree\x18\x0f \x01(\x0b\x32$.ansys.api.dpf.data_tree.v0.DataTreeH\x00\x12\x11\n\x07int_val\x18\x0c \x01(\x05H\x00\x12\x14\n\nstring_val\x18\r \x01(\tH\x00\x12\x14\n\ndouble_val\x18\x0e \x01(\x01H\x00\x42\x06\n\x04\x64\x61ta\"\xb8\x01\n\rCreateRequest\x12)\n\x04type\x18\x01 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\x12\x35\n\x02id\x18\x02 \x01(\x0b\x32\'.ansys.api.dpf.base.v0.EntityIdentifierH\x00\x12\x11\n\x07int_val\x18\x03 \x01(\x05H\x00\x12\x14\n\nstring_val\x18\x04 \x01(\tH\x00\x12\x14\n\ndouble_val\x18\x05 \x01(\x01H\x00\x42\x06\n\x04\x64\x61ta\"A\n\x12GetAsArrayResponse\x12+\n\x05\x61rray\x18\x01 \x01(\x0b\x32\x1c.ansys.api.dpf.base.v0.Array\"o\n\x15\x43reateStreamedRequest\x12)\n\x04type\x18\x01 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\x12+\n\x05\x61rray\x18\x02 \x01(\x0b\x32\x1c.ansys.api.dpf.base.v0.Array2\xd1\x04\n\rDpfAnyService\x12[\n\x06\x43reate\x12\'.ansys.api.dpf.dpf_any.v0.CreateRequest\x1a(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x12X\n\x04List\x12(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x1a&.ansys.api.dpf.dpf_any.v0.ListResponse\x12W\n\x06IsType\x12%.ansys.api.dpf.dpf_any.v0.TypeRequest\x1a&.ansys.api.dpf.dpf_any.v0.TypeResponse\x12X\n\x05GetAs\x12&.ansys.api.dpf.dpf_any.v0.GetAsRequest\x1a\'.ansys.api.dpf.dpf_any.v0.GetAsResponse\x12m\n\x0e\x43reateStreamed\x12/.ansys.api.dpf.dpf_any.v0.CreateStreamedRequest\x1a(.ansys.api.dpf.dpf_any_message.v0.DpfAny(\x01\x12g\n\rGetAsStreamed\x12&.ansys.api.dpf.dpf_any.v0.GetAsRequest\x1a,.ansys.api.dpf.dpf_any.v0.GetAsArrayResponse0\x01\x42\x1a\xaa\x02\x17\x41nsys.Api.Dpf.DpfAny.V0b\x06proto3') +DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rdpf_any.proto\x12\x18\x61nsys.api.dpf.dpf_any.v0\x1a\nbase.proto\x1a\x15\x64pf_any_message.proto\x1a\x10\x63ollection.proto\x1a\x0b\x66ield.proto\x1a\rscoping.proto\x1a\x12\x64\x61ta_sources.proto\x1a\x13meshed_region.proto\x1a\x17time_freq_support.proto\x1a\x14\x63yclic_support.proto\x1a\x16workflow_message.proto\x1a\x11result_info.proto\x1a\x0eoperator.proto\x1a\x1cgeneric_data_container.proto\x1a\x0f\x64\x61ta_tree.proto\"$\n\x0cListResponse\x12\x14\n\x0cwrapped_type\x18\x01 \x01(\t\"\\\n\x0bTypeRequest\x12\x35\n\x03\x61ny\x18\x01 \x01(\x0b\x32(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x12\x16\n\x0erequested_type\x18\x02 \x01(\t\"\"\n\x0cTypeResponse\x12\x12\n\nis_type_of\x18\x01 \x01(\x08\"\x9e\x01\n\x0cGetAsRequest\x12\x35\n\x03\x61ny\x18\x01 \x01(\x0b\x32(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x12)\n\x04type\x18\x02 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\x12,\n\x07subtype\x18\x03 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\"\xf1\x06\n\rGetAsResponse\x12.\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x1d.ansys.api.dpf.field.v0.FieldH\x00\x12=\n\ncollection\x18\x02 \x01(\x0b\x32\'.ansys.api.dpf.collection.v0.CollectionH\x00\x12\x34\n\x07scoping\x18\x03 \x01(\x0b\x32!.ansys.api.dpf.scoping.v0.ScopingH\x00\x12\x42\n\x0c\x64\x61ta_sources\x18\x04 \x01(\x0b\x32*.ansys.api.dpf.data_sources.v0.DataSourcesH\x00\x12<\n\x04mesh\x18\x05 \x01(\x0b\x32,.ansys.api.dpf.meshed_region.v0.MeshedRegionH\x00\x12\x45\n\x0b\x63yc_support\x18\x06 \x01(\x0b\x32..ansys.api.dpf.cyclic_support.v0.CyclicSupportH\x00\x12P\n\x11time_freq_support\x18\x07 \x01(\x0b\x32\x33.ansys.api.dpf.time_freq_support.v0.TimeFreqSupportH\x00\x12?\n\x08workflow\x18\x08 \x01(\x0b\x32+.ansys.api.dpf.workflow_message.v0.WorkflowH\x00\x12;\n\x08operator\x18\t \x01(\x0b\x32\'.ansys.api.dpf.dpf_operator.v0.OperatorH\x00\x12?\n\x0bresult_info\x18\n \x01(\x0b\x32(.ansys.api.dpf.result_info.v0.ResultInfoH\x00\x12_\n\x16generic_data_container\x18\x0b \x01(\x0b\x32=.ansys.api.dpf.generic_data_container.v0.GenericDataContainerH\x00\x12\x39\n\tdata_tree\x18\x0f \x01(\x0b\x32$.ansys.api.dpf.data_tree.v0.DataTreeH\x00\x12\x11\n\x07int_val\x18\x0c \x01(\x05H\x00\x12\x14\n\nstring_val\x18\r \x01(\tH\x00\x12\x14\n\ndouble_val\x18\x0e \x01(\x01H\x00\x42\x06\n\x04\x64\x61ta\"\xe6\x01\n\rCreateRequest\x12)\n\x04type\x18\x01 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\x12\x35\n\x02id\x18\x02 \x01(\x0b\x32\'.ansys.api.dpf.base.v0.EntityIdentifierH\x00\x12\x11\n\x07int_val\x18\x03 \x01(\x05H\x00\x12\x14\n\nstring_val\x18\x04 \x01(\tH\x00\x12\x14\n\ndouble_val\x18\x05 \x01(\x01H\x00\x12,\n\x07subtype\x18\x06 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.TypeB\x06\n\x04\x64\x61ta\"A\n\x12GetAsArrayResponse\x12+\n\x05\x61rray\x18\x01 \x01(\x0b\x32\x1c.ansys.api.dpf.base.v0.Array\"o\n\x15\x43reateStreamedRequest\x12)\n\x04type\x18\x01 \x01(\x0e\x32\x1b.ansys.api.dpf.base.v0.Type\x12+\n\x05\x61rray\x18\x02 \x01(\x0b\x32\x1c.ansys.api.dpf.base.v0.Array2\xd1\x04\n\rDpfAnyService\x12[\n\x06\x43reate\x12\'.ansys.api.dpf.dpf_any.v0.CreateRequest\x1a(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x12X\n\x04List\x12(.ansys.api.dpf.dpf_any_message.v0.DpfAny\x1a&.ansys.api.dpf.dpf_any.v0.ListResponse\x12W\n\x06IsType\x12%.ansys.api.dpf.dpf_any.v0.TypeRequest\x1a&.ansys.api.dpf.dpf_any.v0.TypeResponse\x12X\n\x05GetAs\x12&.ansys.api.dpf.dpf_any.v0.GetAsRequest\x1a\'.ansys.api.dpf.dpf_any.v0.GetAsResponse\x12m\n\x0e\x43reateStreamed\x12/.ansys.api.dpf.dpf_any.v0.CreateStreamedRequest\x1a(.ansys.api.dpf.dpf_any_message.v0.DpfAny(\x01\x12g\n\rGetAsStreamed\x12&.ansys.api.dpf.dpf_any.v0.GetAsRequest\x1a,.ansys.api.dpf.dpf_any.v0.GetAsArrayResponse0\x01\x42\x1a\xaa\x02\x17\x41nsys.Api.Dpf.DpfAny.V0b\x06proto3') _globals = globals() _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals) @@ -47,11 +47,11 @@ _globals['_GETASRESPONSE']._serialized_start=648 _globals['_GETASRESPONSE']._serialized_end=1529 _globals['_CREATEREQUEST']._serialized_start=1532 - _globals['_CREATEREQUEST']._serialized_end=1716 - _globals['_GETASARRAYRESPONSE']._serialized_start=1718 - _globals['_GETASARRAYRESPONSE']._serialized_end=1783 - _globals['_CREATESTREAMEDREQUEST']._serialized_start=1785 - _globals['_CREATESTREAMEDREQUEST']._serialized_end=1896 - _globals['_DPFANYSERVICE']._serialized_start=1899 - _globals['_DPFANYSERVICE']._serialized_end=2492 + _globals['_CREATEREQUEST']._serialized_end=1762 + _globals['_GETASARRAYRESPONSE']._serialized_start=1764 + _globals['_GETASARRAYRESPONSE']._serialized_end=1829 + _globals['_CREATESTREAMEDREQUEST']._serialized_start=1831 + _globals['_CREATESTREAMEDREQUEST']._serialized_end=1942 + _globals['_DPFANYSERVICE']._serialized_start=1945 + _globals['_DPFANYSERVICE']._serialized_end=2538 # @@protoc_insertion_point(module_scope)