ansys.dpf namespace#
Subpackages#
- ansys.dpf.core package
- Subpackages
- Submodules
animate_mode()- Animator
- Any
Any- AvailableResult
HomogeneityHomogeneity.accelerationHomogeneity.angleHomogeneity.angular_velocityHomogeneity.surfaceHomogeneity.capacitanceHomogeneity.electric_chargeHomogeneity.electric_charge_densityHomogeneity.conductivityHomogeneity.currentHomogeneity.densityHomogeneity.displacementHomogeneity.electric_conductivityHomogeneity.electric_fieldHomogeneity.electric_flux_densityHomogeneity.electric_resistivityHomogeneity.energyHomogeneity.film_coefficientHomogeneity.forceHomogeneity.force_intensityHomogeneity.frequencyHomogeneity.heat_fluxHomogeneity.heat_generationHomogeneity.heat_rateHomogeneity.inductanceHomogeneity.inverse_stressHomogeneity.lengthHomogeneity.magnetic_field_intensityHomogeneity.magnetic_fluxHomogeneity.magnetic_flux_densityHomogeneity.massHomogeneity.momentHomogeneity.moment_inertiaHomogeneity.permeabilityHomogeneity.permittivityHomogeneity.poissonHomogeneity.powerHomogeneity.pressureHomogeneity.relative_permeabilityHomogeneity.relative_permittivityHomogeneity.section_modulusHomogeneity.specific_heatHomogeneity.specific_weightHomogeneity.shear_strainHomogeneity.stiffnessHomogeneity.strainHomogeneity.stressHomogeneity.strengthHomogeneity.thermal_expansionHomogeneity.temperatureHomogeneity.timeHomogeneity.velocityHomogeneity.voltageHomogeneity.volumeHomogeneity.moment_inertia_massHomogeneity.stress_intensity_factorHomogeneity.thermal_gradientHomogeneity.resistanceHomogeneity.dimensionlessHomogeneity.dynamic_viscosityHomogeneity.dissipation_rateHomogeneity.momentumHomogeneity.volume_flow_rateHomogeneity.mass_flow_rateHomogeneity.specific_energyHomogeneity.specific_entropy
AvailableResultAvailableResult.nameAvailableResult.n_componentsAvailableResult.dimensionalityAvailableResult.homogeneityAvailableResult.unitAvailableResult.operator_nameAvailableResult.sub_resultsAvailableResult.native_locationAvailableResult.native_scoping_locationAvailableResult.physical_nameAvailableResult.qualifiersAvailableResult.qualifier_labelsAvailableResult.qualifier_combinations
- Collection
CollectionCollection.entries_typeCollection.get_entries()Collection.get_entry()Collection.add_entry()Collection.add_label()Collection.get_available_ids_for_label()Collection.get_entries_indices()Collection.get_label_scoping()Collection.get_label_space()Collection.get_support()Collection.has_label()Collection.integral_collection()Collection.nameCollection.set_labels()Collection.set_support()
CollectionFactory()- CollectionBase
CollectionBaseCollectionBase.entries_typeCollectionBase.nameCollectionBase.integral_collection()CollectionBase.set_labels()CollectionBase.add_label()CollectionBase.has_label()CollectionBase.get_entries_indices()CollectionBase.get_label_space()CollectionBase.get_available_ids_for_label()CollectionBase.get_label_scoping()CollectionBase.set_support()CollectionBase.get_support()
IntegralCollectionIntegralCollection.add_label()IntegralCollection.get_available_ids_for_label()IntegralCollection.get_entries_indices()IntegralCollection.get_label_scoping()IntegralCollection.get_label_space()IntegralCollection.get_support()IntegralCollection.has_label()IntegralCollection.integral_collection()IntegralCollection.nameIntegralCollection.set_labels()IntegralCollection.set_support()IntegralCollection.entries_type
IntCollectionIntCollection.entries_typeIntCollection.add_label()IntCollection.get_available_ids_for_label()IntCollection.get_entries_indices()IntCollection.get_label_scoping()IntCollection.get_label_space()IntCollection.get_support()IntCollection.has_label()IntCollection.integral_collection()IntCollection.nameIntCollection.set_labels()IntCollection.set_support()
FloatCollectionFloatCollection.entries_typeFloatCollection.add_label()FloatCollection.get_available_ids_for_label()FloatCollection.get_entries_indices()FloatCollection.get_label_scoping()FloatCollection.get_label_space()FloatCollection.get_support()FloatCollection.has_label()FloatCollection.integral_collection()FloatCollection.nameFloatCollection.set_labels()FloatCollection.set_support()
StringCollectionStringCollection.add_label()StringCollection.get_available_ids_for_label()StringCollection.get_entries_indices()StringCollection.get_label_scoping()StringCollection.get_label_space()StringCollection.get_support()StringCollection.has_label()StringCollection.integral_collection()StringCollection.nameStringCollection.set_labels()StringCollection.set_support()StringCollection.entries_type
- Common
typestypes.stringtypes.inttypes.doubletypes.booltypes.fieldtypes.collectiontypes.scopingtypes.data_sourcestypes.meshed_regiontypes.time_freq_supporttypes.result_infotypes.cyclic_supporttypes.property_fieldtypes.workflowtypes.runtypes.anytypes.vec_inttypes.vec_doubletypes.supporttypes.operatortypes.data_treetypes.vec_stringtypes.string_fieldtypes.custom_type_fieldtypes.generic_data_containertypes.mesh_infotypes.fields_containertypes.scopings_containertypes.meshes_containertypes.streams_containertypes.bytes
naturesshell_layerselemental_propertiesnodal_propertiesface_propertiesconfig_optionsDefinitionLabelsSubClassSmartDict- Operator Configuration
Config- Core
load_library()upload_file_in_tmp_folder()upload_files_in_folder()download_file()download_files_in_folder()upload_file()make_tmp_dir_server()BaseServiceBaseService.make_tmp_dir_server()BaseService.load_library()BaseService.apply_context()BaseService.initialize_with_context()BaseService.initialize()BaseService.release_dpf()BaseService.server_infoBaseService.download_file()BaseService.download_files_in_folder()BaseService.upload_files_in_folder()BaseService.upload_file()BaseService.upload_file_in_tmp_folder()
- Custom Fields Containers
ElShapeFieldsContainerElShapeFieldsContainer.solid_fields()ElShapeFieldsContainer.shell_fields()ElShapeFieldsContainer.beam_fields()ElShapeFieldsContainer.solid_field()ElShapeFieldsContainer.shell_field()ElShapeFieldsContainer.beam_field()ElShapeFieldsContainer.add_field()ElShapeFieldsContainer.add_field_by_time_id()ElShapeFieldsContainer.add_imaginary_field()ElShapeFieldsContainer.add_label()ElShapeFieldsContainer.animate()ElShapeFieldsContainer.deep_copy()ElShapeFieldsContainer.entries_typeElShapeFieldsContainer.get_available_ids_for_label()ElShapeFieldsContainer.get_entries_indices()ElShapeFieldsContainer.get_field()ElShapeFieldsContainer.get_field_by_time_complex_ids()ElShapeFieldsContainer.get_field_by_time_id()ElShapeFieldsContainer.get_fields()ElShapeFieldsContainer.get_fields_by_time_complex_ids()ElShapeFieldsContainer.get_imaginary_field()ElShapeFieldsContainer.get_imaginary_fields()ElShapeFieldsContainer.get_label_scoping()ElShapeFieldsContainer.get_label_space()ElShapeFieldsContainer.get_support()ElShapeFieldsContainer.get_time_scoping()ElShapeFieldsContainer.has_label()ElShapeFieldsContainer.integral_collection()ElShapeFieldsContainer.nameElShapeFieldsContainer.plot()ElShapeFieldsContainer.select_component()ElShapeFieldsContainer.set_labels()ElShapeFieldsContainer.set_support()ElShapeFieldsContainer.time_freq_support
BodyFieldsContainerBodyFieldsContainer.get_fields_by_mat_id()BodyFieldsContainer.get_field_by_mat_id()BodyFieldsContainer.get_mat_scoping()BodyFieldsContainer.add_field()BodyFieldsContainer.add_field_by_time_id()BodyFieldsContainer.add_imaginary_field()BodyFieldsContainer.add_label()BodyFieldsContainer.animate()BodyFieldsContainer.deep_copy()BodyFieldsContainer.entries_typeBodyFieldsContainer.get_available_ids_for_label()BodyFieldsContainer.get_entries_indices()BodyFieldsContainer.get_field()BodyFieldsContainer.get_field_by_time_complex_ids()BodyFieldsContainer.get_field_by_time_id()BodyFieldsContainer.get_fields()BodyFieldsContainer.get_fields_by_time_complex_ids()BodyFieldsContainer.get_imaginary_field()BodyFieldsContainer.get_imaginary_fields()BodyFieldsContainer.get_label_scoping()BodyFieldsContainer.get_label_space()BodyFieldsContainer.get_support()BodyFieldsContainer.get_time_scoping()BodyFieldsContainer.has_label()BodyFieldsContainer.integral_collection()BodyFieldsContainer.nameBodyFieldsContainer.plot()BodyFieldsContainer.select_component()BodyFieldsContainer.set_labels()BodyFieldsContainer.set_support()BodyFieldsContainer.time_freq_support
- Custom Operator Base
update_virtual_environment_for_custom_operators()record_operator()CustomOperatorBase- CustomTypeField
dict_with_missing_numpy_typedict_with_missing_numpy_type.clear()dict_with_missing_numpy_type.copy()dict_with_missing_numpy_type.fromkeys()dict_with_missing_numpy_type.get()dict_with_missing_numpy_type.items()dict_with_missing_numpy_type.keys()dict_with_missing_numpy_type.pop()dict_with_missing_numpy_type.popitem()dict_with_missing_numpy_type.setdefault()dict_with_missing_numpy_type.update()dict_with_missing_numpy_type.values()
CustomTypeFieldCustomTypeField.locationCustomTypeField.is_of_type()CustomTypeField.typeCustomTypeField.component_countCustomTypeField.elementary_data_countCustomTypeField.sizeCustomTypeField.get_entity_data()CustomTypeField.get_entity_data_by_id()CustomTypeField.append()CustomTypeField.resize()CustomTypeField.unitCustomTypeField.dimensionalityCustomTypeField.nameCustomTypeField.dataCustomTypeField.data_as_listCustomTypeField.elementary_data_shapeCustomTypeField.scopingCustomTypeField.shapeCustomTypeField.field_definition
- Cyclic Support
CyclicSupportCyclicSupport.num_stagesCyclicSupport.num_sectors()CyclicSupport.base_nodes_scoping()CyclicSupport.base_elements_scoping()CyclicSupport.sectors_set_for_expansion()CyclicSupport.expand_node_id()CyclicSupport.expand_element_id()CyclicSupport.cs()CyclicSupport.low_high_map()CyclicSupport.high_low_map()
- Data Sources
DataSourcesDataSources.set_result_file_path()DataSources.guess_result_key()DataSources.guess_second_key()DataSources.set_domain_result_file_path()DataSources.add_file_path()DataSources.add_domain_file_path()DataSources.add_file_path_for_specified_result()DataSources.add_upstream()DataSources.add_upstream_for_domain()DataSources.result_keyDataSources.result_filesDataSources.register_namespace()
- DataTree
DataTree- Dimensionality
Dimensionality- DPFArray
- Operator
Operatoravailable_operator_names()- Element Descriptor
ElementDescriptor- Elements
ElementElementsElements.element_by_id()Elements.element_by_index()Elements.add_elements()Elements.add_solid_element()Elements.add_shell_element()Elements.add_beam_element()Elements.add_point_element()Elements.add_element()Elements.scopingElements.element_types_fieldElements.materials_fieldElements.connectivities_fieldElements.n_elementsElements.mapping_id_to_indexElements.map_scoping()Elements.has_shell_elementsElements.has_solid_elementsElements.has_beam_elementsElements.has_point_elements
ElementAdderelement_typeselement_types.Generalelement_types.Allelement_types.Tet10element_types.Hex20element_types.Wedge15element_types.Pyramid13element_types.Tri6element_types.TriShell6element_types.Quad8element_types.QuadShell8element_types.Line3element_types.Point1element_types.Tet4element_types.Hex8element_types.Wedge6element_types.Pyramid5element_types.Tri3element_types.TriShell3element_types.Quad4element_types.QuadShell4element_types.Line2element_types.NumElementTypeselement_types.Unknownelement_types.EMagLineelement_types.EMagArcelement_types.EMagCircleelement_types.Surface3element_types.Surface4element_types.Surface6element_types.Surface8element_types.Edge2element_types.Edge3element_types.Beam3element_types.Beam4element_types.GeneralPlaceholderelement_types.Polygonelement_types.Polyhedronelement_types.shape()element_types.descriptor()
- Errors
DpfValueErrorInvalidTypeErrorLocationErrorComplexPlottingErrorFieldContainerPlottingErrorInvalidANSYSVersionErrorInvalidPortErrorServerTypeErrorprotect_source_op_not_found()- Faces
- Field
FieldField.as_local_field()Field.locationField.component_countField.elementary_data_countField.sizeField.shell_layersField.get_entity_data()Field.get_entity_data_by_id()Field.append()Field.to_nodal()Field.plot()Field.resize()Field.unitField.dimensionalityField.nameField.field_definitionField.time_freq_supportField.meshed_regionField.dataField.data_as_listField.elementary_data_shapeField.scopingField.shapeField.min()Field.max()Field.deep_copy()
- FieldDefinition
FieldDefinition- FieldsContainer
FieldsContainerFieldsContainer.entries_typeFieldsContainer.get_fields_by_time_complex_ids()FieldsContainer.get_field_by_time_complex_ids()FieldsContainer.get_fields()FieldsContainer.get_field()FieldsContainer.get_field_by_time_id()FieldsContainer.get_imaginary_fields()FieldsContainer.get_imaginary_field()FieldsContainer.add_field()FieldsContainer.add_field_by_time_id()FieldsContainer.add_imaginary_field()FieldsContainer.select_component()FieldsContainer.time_freq_supportFieldsContainer.deep_copy()FieldsContainer.get_time_scoping()FieldsContainer.plot()FieldsContainer.animate()FieldsContainer.add_label()FieldsContainer.get_available_ids_for_label()FieldsContainer.get_entries_indices()FieldsContainer.get_label_scoping()FieldsContainer.get_label_space()FieldsContainer.get_support()FieldsContainer.has_label()FieldsContainer.integral_collection()FieldsContainer.nameFieldsContainer.set_labels()FieldsContainer.set_support()
- fields_container_factory
over_time_freq_fields_container()over_time_freq_complex_fields_container()complex_fields_container()- fields_factory
field_from_array()create_matrix_field()create_3d_vector_field()create_tensor_field()create_scalar_field()create_vector_field()create_overall_field()- GenericDataContainer
GenericDataContainer- GenericSupport
GenericSupportGenericSupport.available_field_supported_properties()GenericSupport.available_prop_field_supported_properties()GenericSupport.available_string_field_supported_properties()GenericSupport.field_support_by_property()GenericSupport.prop_field_support_by_property()GenericSupport.string_field_support_by_property()GenericSupport.set_support_of_property()
- Geometry
normalize_vector()PointsLinePlane- Geometry Factory
create_points()create_line_from_points()create_line_from_vector()create_plane_from_center_and_normal()create_plane_from_points()create_plane_from_lines()create_plane_from_point_and_line()get_center_from_coords()get_normal_direction_from_coords()get_cross_product()- Incremental
IncrementalHelpersplit_workflow_in_chunks()- Inputs
InputInputs- MeshInfo
MeshInfoMeshInfo.generic_data_containerMeshInfo.deep_copy()MeshInfo.get_property()MeshInfo.set_property()MeshInfo.number_facesMeshInfo.part_namesMeshInfo.partsMeshInfo.part_scopingMeshInfo.body_namesMeshInfo.body_scopingMeshInfo.bodiesMeshInfo.zone_namesMeshInfo.zonesMeshInfo.face_zonesMeshInfo.cell_zonesMeshInfo.zone_scopingMeshInfo.number_nodesMeshInfo.number_elementsMeshInfo.splittable_byMeshInfo.available_elem_types
- mesh_scoping_factory
nodal_scoping()elemental_scoping()face_scoping()named_selection_scoping()- MeshedRegion
MeshedRegionMeshedRegion.elementsMeshedRegion.facesMeshedRegion.nodesMeshedRegion.unitMeshedRegion.available_property_fieldsMeshedRegion.property_field()MeshedRegion.set_property_field()MeshedRegion.available_named_selectionsMeshedRegion.named_selection()MeshedRegion.set_named_selection_scoping()MeshedRegion.deform_by()MeshedRegion.gridMeshedRegion.plot()MeshedRegion.deep_copy()MeshedRegion.field_of_properties()
- MeshesContainer
MeshesContainerMeshesContainer.entries_typeMeshesContainer.plot()MeshesContainer.get_meshes()MeshesContainer.get_mesh()MeshesContainer.add_label()MeshesContainer.get_available_ids_for_label()MeshesContainer.get_entries_indices()MeshesContainer.get_label_scoping()MeshesContainer.get_label_space()MeshesContainer.get_support()MeshesContainer.has_label()MeshesContainer.integral_collection()MeshesContainer.nameMeshesContainer.set_labels()MeshesContainer.set_support()MeshesContainer.add_mesh()
- Model
ModelMetadataMetadata.release_streams()Metadata.time_freq_supportMetadata.data_sourcesMetadata.streams_providerMetadata.meshed_regionMetadata.mesh_providerMetadata.result_infoMetadata.mesh_infoMetadata.meshes_containerMetadata.meshes_providerMetadata.available_named_selectionsMetadata.named_selection()
- Nodes
NodeNodesNodeAdder- Operator Specification
PinSpecificationConfigSpecificationConfigSpecification.clear()ConfigSpecification.copy()ConfigSpecification.fromkeys()ConfigSpecification.get()ConfigSpecification.items()ConfigSpecification.keys()ConfigSpecification.pop()ConfigSpecification.popitem()ConfigSpecification.setdefault()ConfigSpecification.update()ConfigSpecification.values()
ConfigOptionSpecSpecificationCustomConfigOptionSpecSpecificationPropertiesCustomSpecification- Outputs
OutputOutputs- path_utilities
join()- Plotter
DpfPlotterplot_chart()Plotter- Python DPF plugins utilities
load_plugin_on_server()- PropertyField
PropertyFieldPropertyField.locationPropertyField.component_countPropertyField.elementary_data_countPropertyField.sizePropertyField.get_entity_data()PropertyField.get_entity_data_by_id()PropertyField.append()PropertyField.as_local_field()PropertyField.namePropertyField.dataPropertyField.data_as_listPropertyField.elementary_data_shapePropertyField.scopingPropertyField.shape
- ResultInfo
physics_typesanalysis_typesResultInfoResultInfo.add_result()ResultInfo.analysis_typeResultInfo.physics_typeResultInfo.n_resultsResultInfo.unit_systemResultInfo.cyclic_symmetry_typeResultInfo.has_cyclicResultInfo.cyclic_supportResultInfo.unit_system_nameResultInfo.solver_versionResultInfo.solver_dateResultInfo.solver_timeResultInfo.user_nameResultInfo.job_nameResultInfo.product_nameResultInfo.main_titleResultInfo.available_resultsResultInfo.available_qualifier_labelsResultInfo.qualifier_label_support()
- Results
ResultsResultCommonResults- RuntimeConfig
RuntimeClientConfigRuntimeCoreConfig- Scoping
Scoping- ScopingsContainer
ScopingsContainerScopingsContainer.entries_typeScopingsContainer.get_scopings()ScopingsContainer.get_scoping()ScopingsContainer.add_label()ScopingsContainer.get_available_ids_for_label()ScopingsContainer.get_entries_indices()ScopingsContainer.get_label_scoping()ScopingsContainer.get_label_space()ScopingsContainer.get_support()ScopingsContainer.has_label()ScopingsContainer.integral_collection()ScopingsContainer.nameScopingsContainer.set_labels()ScopingsContainer.set_support()ScopingsContainer.add_scoping()
- Server
has_local_server()set_server_configuration()port_in_use()shutdown_all_session_servers()start_local_server()connect_to_server()get_or_create_server()available_servers()- ServerContext
LicensingContextTypeLicenseContextManagerServerContextAvailableServerContextsset_default_server_context()- Server factory, server configuration and communication protocols
CommunicationProtocolsDockerConfigServerConfigget_default_server_config()get_default_remote_server_config()AvailableServerConfigsRunningDockerConfigRunningDockerConfig.use_dockerRunningDockerConfig.docker_server_portRunningDockerConfig.server_idRunningDockerConfig.docker_nameRunningDockerConfig.mounted_volumesRunningDockerConfig.extra_argsRunningDockerConfig.replace_with_mounted_volumes()RunningDockerConfig.remove_docker_image()RunningDockerConfig.listen_to_process()
ServerFactory- Server types
check_valid_ip()launch_dpf()launch_dpf_on_docker()BaseServerCServerGrpcServerInProcessServerget_system_path()LegacyGrpcServerLegacyGrpcServer.apply_context()LegacyGrpcServer.check_version()LegacyGrpcServer.contextLegacyGrpcServer.meet_version()LegacyGrpcServer.release()LegacyGrpcServer.sessionLegacyGrpcServer.set_as_global()LegacyGrpcServer.ipLegacyGrpcServer.portLegacyGrpcServer.external_ipLegacyGrpcServer.external_portLegacyGrpcServer.versionLegacyGrpcServer.osLegacyGrpcServer.info
DpfServer- Session
Session- settings
disable_off_screen_rendering()disable_interpreter_properties_evaluation()set_dynamic_available_results_capability()get_runtime_client_config()get_runtime_core_config()- StreamsContainer
StreamsContainer- StringField
StringFieldStringField.locationStringField.component_countStringField.elementary_data_countStringField.sizeStringField.get_entity_data()StringField.get_entity_data_by_id()StringField.append()StringField.dataStringField.data_as_listStringField.elementary_data_shapeStringField.scopingStringField.shape
- Support
Support- time_freq_scoping_factory
scoping_by_load_step()scoping_by_load_steps()scoping_by_set()scoping_by_sets()scoping_by_step_and_substep()scoping_by_step_and_substep_from_model()scoping_on_all_time_freqs()- TimeFreqSupport
TimeFreqSupportTimeFreqSupport.time_frequenciesTimeFreqSupport.complex_frequenciesTimeFreqSupport.rpmsTimeFreqSupport.get_harmonic_indices()TimeFreqSupport.set_harmonic_indices()TimeFreqSupport.n_setsTimeFreqSupport.get_frequency()TimeFreqSupport.get_cumulative_index()TimeFreqSupport.available_field_supported_properties()TimeFreqSupport.available_prop_field_supported_properties()TimeFreqSupport.available_string_field_supported_properties()TimeFreqSupport.field_support_by_property()TimeFreqSupport.prop_field_support_by_property()TimeFreqSupport.string_field_support_by_property()TimeFreqSupport.append_step()TimeFreqSupport.deep_copy()
- UnitSystem
UnitSystemunit_systems- Workflow
WorkflowWorkflow.progress_barWorkflow.connect()Workflow.get_output()Workflow.set_input_name()Workflow.set_output_name()Workflow.add_operators()Workflow.add_operator()Workflow.record()Workflow.get_recorded_workflow()Workflow.infoWorkflow.operator_namesWorkflow.input_namesWorkflow.output_namesWorkflow.connect_with()Workflow.create_on_other_server()Workflow.view()Workflow.to_graphviz()
- Module contents