Logo image Logo image
  • Getting started
  • User guide
  • Concepts
  • API reference
  • Operators
  • Examples
  • Contribute

Navigation

  • PyAnsys »
  • PyDPF-Core »
  • API reference

API reference

  • ansys.dpf.core package
    • ansys.dpf.core.examples package
      • Downloads
    • ansys.dpf.core.operators package
      • ansys.dpf.core.operators.averaging package
        • elemental_difference
        • elemental_difference_fc
        • elemental_fraction_fc
        • elemental_mean
        • elemental_mean_fc
        • elemental_nodal_to_nodal
        • elemental_nodal_to_nodal_elemental
        • elemental_nodal_to_nodal_elemental_fc
        • elemental_nodal_to_nodal_fc
        • elemental_to_elemental_nodal
        • elemental_to_elemental_nodal_fc
        • elemental_to_nodal
        • elemental_to_nodal_fc
        • extend_to_mid_nodes
        • extend_to_mid_nodes_fc
        • gauss_to_node_fc
        • nodal_difference
        • nodal_difference_fc
        • nodal_extend_to_mid_nodes
        • nodal_fraction_fc
        • nodal_to_elemental
        • nodal_to_elemental_fc
        • to_elemental_fc
        • to_elemental_nodal_fc
        • to_nodal
        • to_nodal_fc
      • ansys.dpf.core.operators.filter package
        • field_band_pass
        • field_band_pass_fc
        • field_high_pass
        • field_high_pass_fc
        • field_low_pass
        • field_low_pass_fc
        • field_signed_high_pass
        • scoping_band_pass
        • scoping_high_pass
        • scoping_low_pass
        • signed_scoping_high_pass
      • ansys.dpf.core.operators.geo package
        • element_nodal_contribution
        • elements_facets_surfaces_over_time
        • elements_volume
        • elements_volumes_over_time
        • gauss_to_node
        • integrate_over_elements
        • normals
        • normals_provider_nl
        • rotate
        • rotate_fc
        • rotate_in_cylindrical_cs
        • rotate_in_cylindrical_cs_fc
        • to_polar_coordinates
      • ansys.dpf.core.operators.invariant package
        • convertnum_bcs_to_nod
        • convertnum_nod_to_bcs
        • eigen_values
        • eigen_values_fc
        • eigen_vectors
        • eigen_vectors_fc
        • invariants
        • invariants_fc
        • principal_invariants
        • principal_invariants_fc
        • segalman_von_mises_eqv
        • segalman_von_mises_eqv_fc
        • von_mises_eqv
        • von_mises_eqv_fc
      • ansys.dpf.core.operators.logic package
        • ascending_sort
        • ascending_sort_fc
        • component_selector
        • component_selector_fc
        • descending_sort
        • descending_sort_fc
        • enrich_materials
        • identical_fc
        • identical_fields
        • identical_meshes
        • identical_property_fields
        • included_fields
        • solid_shell_fields
      • ansys.dpf.core.operators.mapping package
        • find_reduced_coordinates
        • on_coordinates
        • on_reduced_coordinates
        • prepare_mapping_workflow
        • scoping_on_coordinates
        • solid_to_skin
      • ansys.dpf.core.operators.math package
        • accumulate
        • accumulate_fc
        • accumulate_level_over_label_fc
        • accumulate_min_over_label_fc
        • accumulate_over_label_fc
        • add
        • add_constant
        • add_constant_fc
        • add_fc
        • amplitude
        • amplitude_fc
        • average_over_label_fc
        • centroid
        • centroid_fc
        • component_wise_divide
        • component_wise_divide_fc
        • conjugate
        • correlation
        • cos
        • cos_fc
        • cplx_derive
        • cplx_divide
        • cplx_dot
        • cplx_multiply
        • cross_product
        • cross_product_fc
        • dot
        • dot_tensor
        • entity_extractor
        • exponential
        • exponential_fc
        • fft_approx
        • fft_eval
        • fft_gradient_eval
        • fft_multi_harmonic_minmax
        • generalized_inner_product
        • generalized_inner_product_fc
        • img_part
        • invert
        • invert_fc
        • kronecker_prod
        • linear_combination
        • ln
        • ln_fc
        • make_one_on_comp
        • matrix_inverse
        • minus
        • minus_fc
        • modal_superposition
        • modulus
        • norm
        • norm_fc
        • outer_product
        • overall_dot
        • phase
        • phase_fc
        • polar_to_cplx
        • pow
        • pow_fc
        • qr_solve
        • real_part
        • scale
        • scale_by_field
        • scale_by_field_fc
        • scale_fc
        • sin
        • sin_fc
        • sqr
        • sqr_fc
        • sqrt
        • sqrt_fc
        • svd
        • sweeping_phase
        • sweeping_phase_fc
        • unit_convert
        • unit_convert_fc
      • ansys.dpf.core.operators.mesh package
        • beam_properties
        • change_cs
        • combine_levelset
        • decimate_mesh
        • exclude_levelset
        • external_layer
        • from_field
        • from_scoping
        • make_plane_levelset
        • make_sphere_levelset
        • mesh_clip
        • mesh_cut
        • mesh_plan_clip
        • mesh_provider
        • mesh_to_graphics
        • mesh_to_graphics_edges
        • meshes_provider
        • node_coordinates
        • points_from_coordinates
        • skin
        • split_fields
        • split_mesh
        • stl_export
        • tri_mesh_skin
      • ansys.dpf.core.operators.metadata package
        • boundary_condition_provider
        • cyclic_mesh_expansion
        • cyclic_support_provider
        • is_cyclic
        • material_provider
        • material_support_provider
        • mesh_selection_manager_provider
        • mesh_support_provider
        • property_field_provider_by_name
        • result_info_provider
        • streams_provider
        • time_freq_provider
      • ansys.dpf.core.operators.min_max package
        • max_by_component
        • max_over_phase
        • max_over_time_by_entity
        • min_by_component
        • min_max
        • min_max_by_entity
        • min_max_by_time
        • min_max_fc
        • min_max_fc_inc
        • min_max_inc
        • min_max_over_label_fc
        • min_max_over_time_by_entity
        • min_over_time_by_entity
        • phase_of_max
        • time_of_max_by_entity
        • time_of_min_by_entity
      • ansys.dpf.core.operators.result package
        • acceleration
        • acceleration_X
        • acceleration_Y
        • acceleration_Z
        • accu_eqv_creep_strain
        • accu_eqv_plastic_strain
        • add_rigid_body_motion
        • add_rigid_body_motion_fc
        • artificial_hourglass_energy
        • beam_axial_force
        • beam_axial_plastic_strain
        • beam_axial_stress
        • beam_axial_total_strain
        • beam_rs_shear_stress
        • beam_s_bending_moment
        • beam_s_shear_force
        • beam_t_bending_moment
        • beam_t_shear_force
        • beam_torsional_moment
        • beam_tr_shear_stress
        • cms_dst_table_provider
        • cms_matrices_provider
        • cms_subfile_info_provider
        • co_energy
        • compute_invariant_terms_rbd
        • compute_stress
        • compute_stress_1
        • compute_stress_2
        • compute_stress_3
        • compute_stress_X
        • compute_stress_XY
        • compute_stress_XZ
        • compute_stress_Y
        • compute_stress_YZ
        • compute_stress_Z
        • compute_stress_von_mises
        • compute_total_strain
        • compute_total_strain_1
        • compute_total_strain_2
        • compute_total_strain_3
        • compute_total_strain_X
        • compute_total_strain_XY
        • compute_total_strain_XZ
        • compute_total_strain_Y
        • compute_total_strain_YZ
        • compute_total_strain_Z
        • contact_fluid_penetration_pressure
        • contact_friction_stress
        • contact_gap_distance
        • contact_penetration
        • contact_pressure
        • contact_sliding_distance
        • contact_status
        • contact_surface_heat_flux
        • contact_total_stress
        • coordinate_system
        • coordinates
        • creep_strain_energy_density
        • current_density
        • custom
        • cyclic_analytic_seqv_max
        • cyclic_analytic_usum_max
        • cyclic_expanded_acceleration
        • cyclic_expanded_displacement
        • cyclic_expanded_el_strain
        • cyclic_expanded_enf
        • cyclic_expanded_heat_flux
        • cyclic_expanded_stress
        • cyclic_expanded_temperature
        • cyclic_expanded_velocity
        • cyclic_expansion
        • cyclic_strain_energy
        • cyclic_volume
        • displacement
        • displacement_X
        • displacement_Y
        • displacement_Z
        • elastic_strain
        • elastic_strain_X
        • elastic_strain_XY
        • elastic_strain_XZ
        • elastic_strain_Y
        • elastic_strain_YZ
        • elastic_strain_Z
        • elastic_strain_energy_density
        • elastic_strain_principal_1
        • elastic_strain_principal_2
        • elastic_strain_principal_3
        • elastic_strain_rotation_by_euler_nodes
        • electric_field
        • electric_flux_density
        • electric_potential
        • element_centroids
        • element_nodal_forces
        • element_orientations
        • elemental_heat_generation
        • elemental_mass
        • elemental_volume
        • enf_rotation_by_euler_nodes
        • equivalent_mass
        • equivalent_radiated_power
        • eqv_stress_parameter
        • erp_accumulate_results
        • erp_radiation_efficiency
        • euler_load_buckling
        • euler_nodes
        • global_added_mass
        • global_added_mass_pct
        • global_center_mass
        • global_energy_ratio
        • global_energy_ratio_wo_eroded
        • global_eroded_hourglass_energy
        • global_eroded_internal_energy
        • global_eroded_kinetic_energy
        • global_external_work
        • global_hourglass_energy
        • global_internal_energy
        • global_joint_internal_energy
        • global_kinetic_energy
        • global_rigid_body_stopper_energy
        • global_sliding_interface_energy
        • global_spring_damper_energy
        • global_system_damping_energy
        • global_time_step
        • global_to_nodal
        • global_total_energy
        • global_total_mass
        • global_velocity
        • heat_flux
        • heat_flux_X
        • heat_flux_Y
        • heat_flux_Z
        • hydrostatic_pressure
        • incremental_energy
        • initial_coordinates
        • interface_contact_area
        • interface_contact_force
        • interface_contact_mass
        • interface_contact_moment
        • interface_resultant_contact_force
        • joint_force_reaction
        • joint_moment_reaction
        • joint_relative_acceleration
        • joint_relative_angular_acceleration
        • joint_relative_angular_velocity
        • joint_relative_displacement
        • joint_relative_rotation
        • joint_relative_velocity
        • kinetic_energy
        • mapdl_material_properties
        • mapdl_section
        • material_property_of_element
        • members_in_bending_not_certified
        • members_in_compression_not_certified
        • members_in_linear_compression_bending_not_certified
        • migrate_to_h5dpf
        • modal_basis
        • nmisc
        • nodal_force
        • nodal_moment
        • nodal_rotation_by_euler_nodes
        • nodal_to_global
        • normal_contact_force
        • normal_contact_moment
        • num_surface_status_changes
        • part_added_mass
        • part_eroded_internal_energy
        • part_eroded_kinetic_energy
        • part_hourglass_energy
        • part_internal_energy
        • part_kinetic_energy
        • part_momentum
        • part_rigid_body_velocity
        • plastic_state_variable
        • plastic_strain
        • plastic_strain_X
        • plastic_strain_XY
        • plastic_strain_XZ
        • plastic_strain_Y
        • plastic_strain_YZ
        • plastic_strain_Z
        • plastic_strain_energy_density
        • plastic_strain_eqv
        • plastic_strain_principal_1
        • plastic_strain_principal_2
        • plastic_strain_principal_3
        • plastic_strain_rotation_by_euler_nodes
        • poynting_vector
        • poynting_vector_surface
        • pres_to_field
        • pressure
        • prns_to_field
        • raw_displacement
        • raw_reaction_force
        • reaction_force
        • recombine_harmonic_indeces_cyclic
        • remove_rigid_body_motion
        • remove_rigid_body_motion_fc
        • result_provider
        • rigid_transformation
        • rom_data_provider
        • run
        • smisc
        • stiffness_matrix_energy
        • stress
        • stress_X
        • stress_XY
        • stress_XZ
        • stress_Y
        • stress_YZ
        • stress_Z
        • stress_principal_1
        • stress_principal_2
        • stress_principal_3
        • stress_ratio
        • stress_rotation_by_euler_nodes
        • stress_von_mises
        • structural_temperature
        • swelling_strains
        • tangential_contact_force
        • tangential_contact_moment
        • temperature
        • temperature_grad
        • thermal_dissipation_energy
        • thermal_strain
        • thermal_strain_X
        • thermal_strain_XY
        • thermal_strain_XZ
        • thermal_strain_Y
        • thermal_strain_YZ
        • thermal_strain_Z
        • thermal_strain_principal_1
        • thermal_strain_principal_2
        • thermal_strain_principal_3
        • thermal_strains_eqv
        • thickness
        • torque
        • total_contact_force
        • total_contact_moment
        • total_mass
        • total_strain
        • transient_rayleigh_integration
        • velocity
        • velocity_X
        • velocity_Y
        • velocity_Z
        • write_cms_rbd_file
        • zone_pressure_spectrum
      • ansys.dpf.core.operators.scoping package
        • change_fc
        • connectivity_ids
        • elemental_from_mesh
        • from_mesh
        • intersect
        • nodal_from_mesh
        • on_mesh_property
        • on_named_selection
        • on_property
        • rescope
        • rescope_fc
        • split_on_property_type
        • transpose
      • ansys.dpf.core.operators.serialization package
        • csv_to_field
        • data_tree_to_json
        • data_tree_to_txt
        • deserializer
        • export_symbolic_workflow
        • field_to_csv
        • import_symbolic_workflow
        • json_to_data_tree
        • mechanical_csv_to_field
        • migrate_file_to_vtk
        • migrate_to_vtu
        • serialize_to_hdf5
        • serializer
        • serializer_to_string
        • string_deserializer
        • txt_to_data_tree
        • vtk_export
        • vtk_to_fields
        • vtu_export
        • workflow_export_json
        • workflow_import_json
      • ansys.dpf.core.operators.server namespace
      • ansys.dpf.core.operators.utility package
        • assemble_scalars_to_matrices
        • assemble_scalars_to_vectors
        • bind_support
        • bind_support_fc
        • change_location
        • change_shell_layers
        • default_value
        • extract_field
        • extract_scoping
        • extract_sub_fc
        • extract_sub_mc
        • extract_sub_sc
        • extract_time_freq
        • field_to_fc
        • forward
        • forward_field
        • forward_fields_container
        • forward_meshes_container
        • hdf5dpf_custom_read
        • html_doc
        • make_overall
        • merge_fields
        • merge_fields_by_label
        • merge_fields_containers
        • merge_materials
        • merge_meshes
        • merge_meshes_containers
        • merge_property_fields
        • merge_result_infos
        • merge_scopings
        • merge_scopings_containers
        • merge_supports
        • merge_time_freq_supports
        • merge_weighted_fields
        • merge_weighted_fields_containers
        • overlap_fields
        • python_generator
        • remote_operator_instantiate
        • remote_workflow_instantiate
        • scalars_to_field
        • set_property
        • strain_from_voigt
        • txt_file_to_dpf
        • unitary_field
    • Animator
    • AvailableResult
    • Collection
    • Common
    • Operator Configuration
    • Core
    • Custom Fields Containers
    • Custom Operator Base
    • CustomTypeField
    • Cyclic Support
    • Data Sources
    • DataTree
    • Dimensionality
    • DPFArray
    • Operator
    • Element Descriptor
    • Elements
    • Errors
    • Field
    • FieldDefinition
    • FieldsContainer
    • fields_container_factory
    • fields_factory
    • GenericSupport
    • Inputs
    • mesh_scoping_factory
    • MeshedRegion
    • MeshesContainer
    • Model
    • Nodes
    • Operator Specification
    • Outputs
    • path_utilities
    • Plotter
    • PropertyField
    • ResultInfo
    • Results
    • RuntimeConfig
    • Scoping
    • ScopingsContainer
    • Server
    • ServerContext
    • Server factory, server configuration and communication protocols
    • Server types
    • Session
    • settings
    • StreamsContainer
    • StringField
    • Support
    • time_freq_scoping_factory
    • TimeFreqSupport
    • Workflow

API reference#

API reference

  • ansys.dpf.core package
    • Subpackages
    • Submodules
    • Module contents

© Copyright (c) 2022 ANSYS, Inc. All rights reserved.

Created using Sphinx 5.1.1.