SourceSampling

class ansys.speos.core.simulation.BaseSimulation.SourceSampling(source_sampling, default_values=True, stable_ctr=False)

Source sampling mode.

Parameters:

source_samplingUnion[

simulation_template_pb2.RoughnessOnly, simulation_template_pb2.Iridescence, simulation_template_pb2.Isotropic, simulation_template_pb2.Anisotropic] to complete.

default_values: bool

True to use the default values as uniform source sampling.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

• source_sampling (Union[ansys.api.speos.simulation.v1.simulation_template_pb2.RoughnessOnly, ansys.api.speos.simulation.v1.simulation_template_pb2.Iridescence, ansys.api.speos.simulation.v1.simulation_template_pb2.Isotropic, ansys.api.speos.simulation.v1.simulation_template_pb2.Anisotropic])

• default_values (bool)

• stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_weight method available in simulation classes.

Overview

Methods

set_uniform	Set uniform type of source sampling.
set_adaptive	Set adaptive type of source sampling.

Import detail

from ansys.speos.core.simulation.BaseSimulation import SourceSampling

Method detail

SourceSampling.set_uniform()

Set uniform type of source sampling.

Returns:

ansys.speos.core.simulation.BaseSimulation.SourceSampling.Uniform

Uniform source sampling settings to be set

SourceSampling.set_adaptive()

Set adaptive type of source sampling.

Returns:

ansys.speos.core.simulation.BaseSimulation.SourceSampling.Adaptive

Adaptive source sampling settings to be set

Classes

Adaptive	Adaptive sampling mode.
Uniform	Uniform sampling mode.