report.Chart3D

class Chart3D

Bases: Chart

Represents a 3D chart within a report, displaying a specific surface field.

Attributes

section_title: str, optional

The title of the chart section.

Default:

None

fig_name: str, optional

Name of the figure file or identifier for the chart (). Only ‘^[a-zA-Z0-9._-]+$’ allowed.

Default:

None

fig_size: float

Relative size of the figure as a fraction of text width.

Default:

0.7

items_in_row: int, optional

Number of items to display in a row within the chart section.

Default:

None

select_indices: list[int], optional

Specific indices to select for the chart.

Default:

None

separate_plots: bool, optional

If True, display as multiple plots; otherwise single plot.

Default:

None

force_new_page: bool

If True, starts the chart on a new page in the report.

Default:

False

caption: str | list[str] | PatternCaption, optional

Caption to be shown for figures.

Default:

''

field: Literal['Cp', 'Cpt', 'gradW', 'kOmega', 'Mach', 'mut', 'mutRatio', 'nuHat', 'primitiveVars', 'qcriterion', 'residualNavierStokes', 'residualTransition', 'residualTurbulence', 's', 'solutionNavierStokes', 'solutionTransition', 'solutionTurbulence', 'T', 'velocity', 'velocity_x', 'velocity_y', 'velocity_z', 'velocity_magnitude', 'pressure', 'vorticity', 'vorticityMagnitude', 'vorticity_x', 'vorticity_y', 'vorticity_z', 'wallDistance', 'numericalDissipationFactor', 'residualHeatSolver', 'VelocityRelative', 'lowMachPreconditionerSensor', 'velocity_m_per_s', 'velocity_x_m_per_s', 'velocity_y_m_per_s', 'velocity_z_m_per_s', 'velocity_magnitude_m_per_s', 'pressure_pa', 'CfVec', 'Cf', 'heatFlux', 'nodeNormals', 'nodeForcesPerUnitArea', 'yPlus', 'wallFunctionMetric', 'heatTransferCoefficientStaticTemperature', 'heatTransferCoefficientTotalTemperature', 'wall_shear_stress_magnitude', 'wall_shear_stress_magnitude_pa'] | str, optional

The name of the field to display in the chart.

Default:

None

camera: Camera | BottomCamera | FrontCamera | FrontLeftBottomCamera | FrontLeftTopCamera | LeftCamera | RearCamera | RearLeftTopCamera | RearRightBottomCamera | TopCamera, optional

Specify how the view will be set up.

Default:

Camera()

limits: tuple[float, float] | tuple[LengthType | AngleType | MassType | TimeType | AbsoluteTemperatureType | VelocityType | AreaType | ForceType | PressureType | DensityType | ViscosityType | KinematicViscosityType | PowerType | MomentType | AngularVelocityType | HeatFluxType | HeatSourceType | SpecificHeatCapacityType | ThermalConductivityType | InverseAreaType | InverseLengthType | MassFlowRateType | SpecificEnergyType | FrequencyType, LengthType | AngleType | MassType | TimeType | AbsoluteTemperatureType | VelocityType | AreaType | ForceType | PressureType | DensityType | ViscosityType | KinematicViscosityType | PowerType | MomentType | AngularVelocityType | HeatFluxType | HeatSourceType | SpecificHeatCapacityType | ThermalConductivityType | InverseAreaType | InverseLengthType | MassFlowRateType | SpecificEnergyType | FrequencyType], optional

Limits for the field values, specified as a tuple (min, max).

Default:

None

is_log_scale: bool

Applies a logarithmic scale to the colormap. Defaults to False.

Default:

False

iso_field: Literal['Mach', 'qcriterion', 's', 'T', 'Cp', 'Cpt', 'mut', 'nuHat', 'vorticityMagnitude', 'vorticity_x', 'vorticity_y', 'vorticity_z', 'velocity_magnitude', 'velocity_x', 'velocity_y', 'velocity_z'] | str, optional

Iso-surface fields to be displayed when isosurface is selected in show.

Default:

None

mode: Literal['contour', 'lic'], optional

Field display mode, lic stands for line integral convolution.

Default:

'contour'

include: list[str], optional

Boundaries to be included in the chart.

Default:

None

exclude: list[str], optional

Boundaries to be excluded from the chart.

Default:

None

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

get_requirements()

get requirements

get_doc_item(context, settings=None)

returns doc item for 3D chart

Parameters:

• context (ReportContext)

• settings (Settings | None)

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')