time_freq_scoping_factory#
Contains functions to simplify creating time frequency scopings.
- ansys.dpf.core.time_freq_scoping_factory.scoping_by_load_step(load_step: int, server=None)#
Create a specific
ansys.dpf.core.Scoping
for a given load step.The returned scoping describes a specific time frequency support element for a given load step.
- Parameters:
load_step (int) – Load step ID of the specific time frequency scoping.
server (DpfServer, optional) – Server with the channel connected to the remote or local instance. The default is
None
, in which case an attempt is made to use the global server.
- Returns:
scoping – Scoping targeting one load step.
- Return type:
- ansys.dpf.core.time_freq_scoping_factory.scoping_by_load_steps(load_steps: list, server=None)#
Create a specific
ansys.dpf.core.Scoping
for a given list of load steps.The returned scoping describes a specific time frequency support element for a given list of load steps.
- Parameters:
load_steps (list[int]) – List of load steps IDs of the specific time frequency scoping.
server (DpfServer, optional) – Server with the channel connected to the remote or local instance. The default is
None
, in which case an attempt is made to use the global server.
- Returns:
scoping – Scoping targeting several load_steps.
- Return type:
- ansys.dpf.core.time_freq_scoping_factory.scoping_by_set(cumulative_set, server=None)#
Create a specific
ansys.dpf.core.Scoping
for a given cumulative set index.The returned scoping describes a specific time frequency support element for a given cumulative set index.
- Parameters:
cumulative_set (int) – Cumulative index of the set.
server (DpfServer, optional) – Server with the channel connected to the remote or local instance. The default is
None
, in which case an attempt is made to use the global server.
- Returns:
scoping – Scoping targeting one set (referenced by cumulative index).
- Return type:
- ansys.dpf.core.time_freq_scoping_factory.scoping_by_sets(cumulative_sets, server=None)#
Create a specific
ansys.dpf.core.Scoping
for a given list of cumulative set indices.The returned scoping describes a specific time frequency support element for a given list of cumulative sets of indices.
- Parameters:
cumulative_sets (list[int]) – List of cumulative indices of the sets.
server (DpfServer, optional) – Server with the channel connected to the remote or local instance. The default is
None
, in which case an attempt is made to use the global server.
- Returns:
scoping – Scoping targeting severals sets (referenced by cumulative indices).
- Return type:
- ansys.dpf.core.time_freq_scoping_factory.scoping_by_step_and_substep(load_step_id, subset_id, time_freq_support)#
Create a specific
ansys.dpf.core.Scoping
for a given step and subset.The returned scoping describes a specific time frequency support element for a given step and substep.
- Parameters:
load_step_id (int) – ID of the load step.
subset_id (int) – ID of the subset.
time_freq_support (TimeFreqSupport) –
- Returns:
scoping – Scoping based on a given step and substep of a time frequency support.
- Return type:
- ansys.dpf.core.time_freq_scoping_factory.scoping_by_step_and_substep_from_model(load_step_id, subset_id, model, server=None)#
Create a specific
ansys.dpf.core.Scoping
for a given step and substep.The returned scoping describes a specific model’s time freq support element for a given step and substep.
- Parameters:
load_step_id (int) – ID of the step.
subset_id (int) – ID of the subset.
model (Model) –
server (DpfServer, optional) – Server with the channel connected to the remote or local instance. The default is
None
, in which case an attempt is made to use the global server.
- Returns:
scoping – Scoping based on a given step/substep of a model’s time_freq_support.
- Return type:
- ansys.dpf.core.time_freq_scoping_factory.scoping_on_all_time_freqs(obj: ansys.dpf.core.time_freq_support.TimeFreqSupport | ansys.dpf.core.model.Model | ansys.dpf.core.data_sources.DataSources)#
Create a specific
ansys.dpf.core.Scoping
with all time or frequency sets of aansys.dpf.core.TimeFreqSupport
or a class:ansys.dpf.core.Model- Parameters:
tf_support_or_model (TimeFreqSupport, Model) –
- Returns:
scoping – Scoping with all time or frequency sets IDs.
- Return type: