The `ansys.dpf.core` library#

Summary#

Subpackages

`documentation`	Documentation generation tools.
`examples`	Provide utility functions for downloading and locating DPF example files.
`helpers`	Provide helpers relating to streamline computation, argument filtering, and text indenting.
`operators`
`workflow_topology`	Workflow topology module.

Submodules

`animation`	Module contains the function for modal animation creation.
`animator`	Animator.
`any`	Any.
`available_result`	AvailableResult.
`changelog`	Provides classes for changelogs.
`collection`	Module containing the class representing dpf objects organized by label spaces.
`collection_base`	Contains classes associated with the DPF collection.
`common`	Common.
`config`	Operator Configuration.
`core`	Core.
`custom_container_base`	CustomContainerBase.
`custom_fields_container`	Custom Fields Containers.
`custom_operator`	Custom Operator Base.
`custom_type_field`	CustomTypeField.
`cyclic_support`	Cyclic Support.
`data_sources`	Data sources.
`data_tree`	DataTree.
`dimensionality`	Dimensionality.
`dpf_array`	DPFArray.
`dpf_operator`	Operator.
`element_descriptor`	Element Descriptor.
`elements`	Elements.
`errors`	Errors.
`faces`	Faces.
`field`	Field.
`field_definition`	FieldDefinition.
`fields_container`	FieldsContainer.
`fields_container_factory`	fields_container_factory.
`fields_factory`	fields_factory.
`generic_data_container`	GenericDataContainer.
`generic_support`	GenericSupport.
`geometry`	Geometry.
`geometry_factory`	Geometry Factory.
`incremental`	Incremental.
`inputs`	Inputs.
`mesh_info`	MeshInfo.
`mesh_scoping_factory`	mesh_scoping_factory.
`meshed_region`	MeshedRegion.
`meshes_container`	MeshesContainer.
`model`	Model.
`nodes`	Nodes.
`operator_specification`	Operator Specification.
`outputs`	Outputs.
`path_utilities`	path_utilities.
`plotter`	Plotter.
`plugins`	Python DPF plugins utilities.
`property_field`	PropertyField.
`result_info`	ResultInfo.
`results`	Results.
`runtime_config`	RuntimeConfig.
`scoping`	Scoping.
`scopings_container`	ScopingsContainer.
`server`	Server.
`server_context`	ServerContext.
`server_factory`	Server factory, server configuration and communication protocols.
`server_types`	Server types.
`session`	Session.
`settings`	settings.
`streams_container`	StreamsContainer.
`string_field`	StringField.
`support`	Support.
`time_freq_scoping_factory`	time_freq_scoping_factory.
`time_freq_support`	TimeFreqSupport.
`unit_system`	UnitSystem.
`workflow`	Workflow.

Attributes

`__version__`
`spec`
`installed`
`check_for`
`CustomTypeFieldsCollection`
`GenericDataContainersCollection`
`StringFieldsCollection`
`OperatorsCollection`
`AnyCollection`

Constants

`USER_DATA_PATH`
`LOCAL_DOWNLOADED_EXAMPLES_PATH`
`SERVER`
`SERVER_CONFIGURATION`

Module detail#

core.USER_DATA_PATH = None#

core.LOCAL_DOWNLOADED_EXAMPLES_PATH = None#

core.SERVER = None#

core.SERVER_CONFIGURATION = None#

core.__version__#

core.spec = None#

core.installed#

core.check_for = ['ansys-dpf-gatebin', 'ansys-dpf-gate', 'ansys-grpc-dpf']#

core.CustomTypeFieldsCollection: type#

core.GenericDataContainersCollection: type#

core.StringFieldsCollection: type#

core.OperatorsCollection: type#

core.AnyCollection: type#