flow360.report.Chart3D

class Chart3D

Bases: Chart

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

field: SurfaceFieldNames | str | None = None

The name of the field to display in the chart.

camera: Camera | BottomCamera | FrontCamera | FrontLeftBottomCamera | FrontLeftTopCamera | LeftCamera | RearCamera | RearLeftTopCamera | RearRightBottomCamera | TopCamera | None = Camera(position=(-1.0, -1.0, 1.0), up=(0.0, 0.0, 1.0), look_at=None, pan_target=None, dimension_dir='width', dimension=None, type='Camera')

Specify how the view will be set up.

limits: Tuple[float, float] | Tuple[DimensionedTypes, DimensionedTypes] | None = None

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

is_log_scale: bool = False

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

show: ShutterObjectTypes [Required]

Type of object to display in the 3D chart. Note: qcriterion refers to an iso-surface that is created by default, whereas isosurface refers to iso-surfaces specified in simulation outputs.

iso_field: IsoSurfaceFieldNames | str | None = None

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

mode: Literal['contour', 'lic'] | None = 'contour'

Field display mode, lic stands for line integral convolution.

include: List[str] | None = None

Boundaries to be included in the chart.

exclude: List[str] | None = None

Boundaries to be excluded from the chart.

type_name: Literal['Chart3D'] = 'Chart3D'

get_requirements()

get requirements

get_doc_item(context, settings=None)

returns doc item for 3D chart

Parameters:

• context (ReportContext)

• settings (Settings | None)

section_title: str | None = None

The title of the chart section.

fig_name: FileNameStr | None = None

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

fig_size: float = 0.7

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

items_in_row: int | None = None

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

select_indices: List[NonNegativeInt] | None = None

Specific indices to select for the chart.

separate_plots: bool | None = None

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

force_new_page: bool = False

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

caption: str | List[str] | PatternCaption | None = ''

Caption to be shown for figures.