pyopensn.fieldfunc.FieldFunctionInterpolationVolume

class pyopensn.fieldfunc.FieldFunctionInterpolationVolume

A line based interpolation function.

Wrapper of opensn::FieldFunctionInterpolationVolume.

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

GetValue(self: pyopensn.fieldfunc.FieldFunctionInterpolationVolume) → float

???

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

???

SetLogicalVolume(self: pyopensn.fieldfunc.FieldFunctionInterpolationVolume, lv: pyopensn.logvol.LogicalVolume) → None

Set logical volume.

SetOperationFunction(self: pyopensn.fieldfunc.FieldFunctionInterpolationVolume, function: pyopensn.math.ScalarMaterialFunction) → None

???

Parameters:

function (pyopensn.math.ScalarMaterialFunction) –

???

SetOperationType(self: pyopensn.fieldfunc.FieldFunctionInterpolationVolume, op_type: str) → None

Set operation type.

Parameters:

op_type ({'sum', 'avg', 'max', 'sum_func', 'avg_func', 'max_func'}) – Operation type.

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

Default constructor.