pyopensn.fieldfunc.FieldFunctionInterpolationLine

class pyopensn.fieldfunc.FieldFunctionInterpolationLine

Line based interpolation function.

Wrapper of opensn::FieldFunctionInterpolationLine.

AddFieldFunction(self: pyopensn.fieldfunc.FieldFunctionInterpolation, ff: pyopensn.fieldfunc.FieldFunction) → None

Add a field function to the list.

Execute(self: pyopensn.fieldfunc.FieldFunctionInterpolation) → None

???

ExportToCSV(self: pyopensn.fieldfunc.FieldFunctionInterpolation, base_name: str) → None

Export field function interpolation to CSV files.

Parameters:

base_name (str) – Base name of the exported CSVs.

static GetFieldFunctionByName(ff_name: str) → list

Get the list of field functions matching a given name.

This function returns a list of field functions whose names match the given argument. The list may be empty or contain multiple elements.

Parameters:

ff_name (str) – Field function name

Initialize(self: pyopensn.fieldfunc.FieldFunctionInterpolation) → None

???

SetFinalPoint(self: pyopensn.fieldfunc.FieldFunctionInterpolationLine, point: pyopensn.math.Vector3) → None

Set final point.

Parameters:

point (pyopensn.math.Vector3) – Coordinates of the final point.

SetInitialPoint(self: pyopensn.fieldfunc.FieldFunctionInterpolationLine, point: pyopensn.math.Vector3) → None

Set initial point.

Parameters:

point (pyopensn.math.Vector3) – Coordinates of the initial point.

SetNumberOfPoints(self: pyopensn.fieldfunc.FieldFunctionInterpolationLine, number: int) → None

Set number of points.

Parameters:

number (int) – Number of points.

__init__(self: pyopensn.fieldfunc.FieldFunctionInterpolationLine) → None

Default constructor.