get_scalar_field_value

PostProcessor.get_scalar_field_value(quantity_name, scalar_function='Maximum', solution=None, variation_dict=None, isvector=False, intrinsics=None, phase=None)[source]

Use the field calculator to Compute Scalar of a Field.

Parameters
quantity_namestr

Name of the quantity to export. For example, "Temp".

solutionstr, optional

Name of the solution in the format "solution : sweep". The default is None.

variation_dictdict, optional

Dictionary of all variation variables with their values. The default is None.

isvectorbool, optional

Whether the quantity is a vector. The default is False.

intrinsicsstr, optional

This parameter is mandatory for a frequency field calculation. The default is None.

phasestr, optional

Field phase. The default is None.

Returns
float

True when successful, False when failed.

References

>>> oModule.EnterQty
>>> oModule.CopyNamedExprToStack
>>> oModule.CalcOp
>>> oModule.EnterQty
>>> oModule.EnterVol
>>> oModule.CalculatorWrite