serialize_to_hdf5¶

class ansys.dpf.core.operators.serialization.serialize_to_hdf5.serialize_to_hdf5(file_path=None, export_floats=None, export_flat_vectors=None, data1=None, data2=None, config=None, server=None)¶

Serialize the inputs in an hdf5 format.

available inputs:

file_path (str)
export_floats (bool)
export_flat_vectors (bool)
data1 (Any)
data2 (Any)

available outputs:

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.serialization.serialize_to_hdf5()

>>> # Make input connections
>>> my_file_path = str()
>>> op.inputs.file_path.connect(my_file_path)
>>> my_export_floats = bool()
>>> op.inputs.export_floats.connect(my_export_floats)
>>> my_export_flat_vectors = bool()
>>> op.inputs.export_flat_vectors.connect(my_export_flat_vectors)
>>> my_data1 = dpf.Any()
>>> op.inputs.data1.connect(my_data1)
>>> my_data2 = dpf.Any()
>>> op.inputs.data2.connect(my_data2)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.serialization.serialize_to_hdf5(file_path=my_file_path,export_floats=my_export_floats,export_flat_vectors=my_export_flat_vectors,data1=my_data1,data2=my_data2)

>>> # Get output data

static default_config()¶

Returns the default config for a given operator. This config can then be changed to the user needs and be used to instantiate the given operator

Parameters

name (str) – Name of the operator. For example ‘U’.
server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the the global server.

property inputs¶

Enables to connect inputs to the operator

Returns: inputs
Return type: InputsSerializeToHdf5

property outputs¶

Enables to get outputs of the operator by evaluationg it

Returns: outputs
Return type: OutputsSerializeToHdf5

property config¶

Returns a copy of the current config of the operator. To use the config that you modify, please use operator.config = new_config or create an operator with the new config as a parameter.

Returns: config
Return type: Config

connect(pin, inpt, pin_out=0)¶

Connect an input on the operator using a pin number.

Parameters

pin (int) – Number of the input pin.
inpt (str, int, double, bool, list of int, list of doubles, Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion, MeshesContainer, DataSources, Operator) – Object you wish to connect.
pin_out (int, optional) – In case of the input is an Operator, this is the output pin of the input Operator. Defaults to 0.

Examples

Compute the minimum of displacement by chaining the 'U' and 'min_max_fc' operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.multishells_rst)
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
array([[0.59428386, 0.00201751, 0.0006032 ]])

get_output(pin=0, output_type=None)¶

Returns the output of the operator on the pin number.

Parameters

pin (int, optional) – Number of the output pin.
output_type (core.type enum, optional) – The requested type of the output.

run()¶: Evaluate this operator

class ansys.dpf.core.operators.serialization.serialize_to_hdf5.InputsSerializeToHdf5(op: ansys.dpf.core.dpf_operator.Operator)¶

Intermediate class used to connect user inputs to serialize_to_hdf5 operator

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.serialization.serialize_to_hdf5()
>>> my_file_path = str()
>>> op.inputs.file_path.connect(my_file_path)
>>> my_export_floats = bool()
>>> op.inputs.export_floats.connect(my_export_floats)
>>> my_export_flat_vectors = bool()
>>> op.inputs.export_flat_vectors.connect(my_export_flat_vectors)
>>> my_data1 = dpf.Any()
>>> op.inputs.data1.connect(my_data1)
>>> my_data2 = dpf.Any()
>>> op.inputs.data2.connect(my_data2)

property file_path¶

Allows to connect file_path input to the operator

pindoc: output file path with .h5 extension

Parameters: my_file_path (str,) –

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.serialization.serialize_to_hdf5()
>>> op.inputs.file_path.connect(my_file_path)
>>> #or
>>> op.inputs.file_path(my_file_path)

property export_floats¶

Allows to connect export_floats input to the operator

pindoc: converts double to float to reduce file size (default is true)

Parameters: my_export_floats (bool,) –

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.serialization.serialize_to_hdf5()
>>> op.inputs.export_floats.connect(my_export_floats)
>>> #or
>>> op.inputs.export_floats(my_export_floats)

property export_flat_vectors¶

Allows to connect export_flat_vectors input to the operator

pindoc: if true, vectors and matrices data are exported flat (x1,y1,z1,x2,y2,z2..) (default is false)

Parameters: my_export_flat_vectors (bool,) –

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.serialization.serialize_to_hdf5()
>>> op.inputs.export_flat_vectors.connect(my_export_flat_vectors)
>>> #or
>>> op.inputs.export_flat_vectors(my_export_flat_vectors)

property data1¶

Allows to connect data1 input to the operator

pindoc: only the data set explicitly to export is exported

Parameters: my_data1 (Any,) –

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.serialization.serialize_to_hdf5()
>>> op.inputs.data1.connect(my_data1)
>>> #or
>>> op.inputs.data1(my_data1)

property data2¶

Allows to connect data2 input to the operator

pindoc: only the data set explicitly to export is exported

Parameters: my_data2 (Any,) –

Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.serialization.serialize_to_hdf5()
>>> op.inputs.data2.connect(my_data2)
>>> #or
>>> op.inputs.data2(my_data2)

connect(inpt)¶

Allows you to connect any input (an entity or an operator output) to any input pin of this operator.

The matching input type corresponding to the output is looked for.

Parameters: inpt (str, int, double, Field, FieldsContainer, Scoping, DataSources, MeshedRegion, ScopingsContainer, CyclicSupport, ..., Output, Outputs, Operator) – input of the operator

class ansys.dpf.core.operators.serialization.serialize_to_hdf5.OutputsSerializeToHdf5(op: ansys.dpf.core.dpf_operator.Operator)¶

Intermediate class used to get outputs from serialize_to_hdf5 operator .. rubric:: Examples

>>> from ansys.dpf import core as dpf

>>> op = dpf.operators.serialization.serialize_to_hdf5()
>>> # Connect inputs : op.inputs. ...

migrate_file_to_vtk serializer