pyopensn.fieldfunc.FieldFunctionGridBased

class pyopensn.fieldfunc.FieldFunctionGridBased

Field function grid based.

Wrapper of opensn::FieldFunctionGridBased.

CanUpdate(self: pyopensn.fieldfunc.FieldFunctionGridBased) → bool

Return whether this field function can currently refresh itself from its owning solver.

This returns False if the field function has no update callback or if the owning solver has already been destroyed.

static ExportMultipleToPVTU(ff_list: list, base_name: str) → None

Export a list of “field function grid based” to parallel VTU format.

Parameters:

  • ff_list (List[opensn.FieldFunctionGridBased]) – List of “field function grid based” to export.

  • base_name (str) – Base name.

Update(self: pyopensn.fieldfunc.FieldFunctionGridBased) → None

Refresh this field function from its owning solver.

Raises an error if the field function is not refreshable or if its owning solver has already been destroyed.