result:transient rayleigh integration
Last update: 31.07.2026Version: 0.0.0
Description
Computes the transient Rayleigh integral
Inputs
This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.
| Pin number | Name | Status | Expected type(s) |
|---|---|---|---|
| 0 | fields_container | Required | fields_container |
| 1 | mesh | Required | abstract_meshed_region, meshes_container |
| 2 | time_scoping | Required | int32, vector<int32>, scoping |
| 3 | field | Required | field |
| 4 | observation_mesh | Required | abstract_meshed_region |
| 5 | mass_density | Required | double |
| 6 | speed_of_sound | Required | double |
fields_container (Pin 0)
- Required: Yes
- Expected type(s):
fields_container
the input field container expects acceleration fields
mesh (Pin 1)
- Required: Yes
- Expected type(s):
abstract_meshed_region,meshes_container
The meshes region in this pin has to be boundary or skin mesh. This is the source meshes.
time_scoping (Pin 2)
- Required: Yes
- Expected type(s):
int32,vector<int32>,scoping
Load step number (if it's specified, the Transient rayleigh integration is computed only on the substeps of this step) or time scoping
field (Pin 3)
- Required: Yes
- Expected type(s):
field
The field represents the coordinates of the observation position. It should be specified if not observation mesh is provided.
observation_mesh (Pin 4)
- Required: Yes
- Expected type(s):
abstract_meshed_region
This is the observation mesh region
mass_density (Pin 5)
- Required: Yes
- Expected type(s):
double
Mass density (if it's not specified, default value of the air is applied).
speed_of_sound (Pin 6)
- Required: Yes
- Expected type(s):
double
Speed of sound (if it's not specified, default value of the speed of sound in the air is applied).
Outputs
This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.
| Pin number | Name | Expected type(s) |
|---|---|---|
| 0 | fields_container | fields_container |
fields_container (Pin 0)
- Expected type(s):
fields_container
Configurations
This operator supports configuration options that modify its behavior.
mutex
- Expected type(s):
bool - Default value: false
If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.
Scripting
This operator can be accessed through scripting interfaces using these identifiers.
Category: result
Plugin: core
Scripting name: transient_rayleigh_integration
Full name: result.transient_rayleigh_integration
Internal name: transient_rayleigh_integration
License: any_dpf_supported_increments
Examples
These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.
C++
#include "dpf_api.h"
ansys::dpf::Operator op("transient_rayleigh_integration"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_mesh);
op.connect(2, my_time_scoping);
op.connect(3, my_field);
op.connect(4, my_observation_mesh);
op.connect(5, my_mass_density);
op.connect(6, my_speed_of_sound);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.result.transient_rayleigh_integration() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.mesh.connect(my_mesh)
op.inputs.time_scoping.connect(my_time_scoping)
op.inputs.field.connect(my_field)
op.inputs.observation_mesh.connect(my_observation_mesh)
op.inputs.mass_density.connect(my_mass_density)
op.inputs.speed_of_sound.connect(my_speed_of_sound)
my_fields_container = op.outputs.fields_container()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.result.transient_rayleigh_integration() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.mesh.Connect(my_mesh)
op.inputs.time_scoping.Connect(my_time_scoping)
op.inputs.field.Connect(my_field)
op.inputs.observation_mesh.Connect(my_observation_mesh)
op.inputs.mass_density.Connect(my_mass_density)
op.inputs.speed_of_sound.Connect(my_speed_of_sound)
my_fields_container = op.outputs.fields_container.GetData()
Changelog
- Version 0.0.0: Initial release.