export_field_file_on_grid#

PostProcessor.export_field_file_on_grid(quantity_name, solution=None, variation_dict=None, filename=None, gridtype='Cartesian', grid_center=[0, 0, 0], grid_start=[0, 0, 0], grid_stop=[0, 0, 0], grid_step=[0, 0, 0], isvector=False, intrinsics=None, phase=None)[source]#

Use the field calculator to create a field file on a grid based on a solution and variation.

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.
filenamestr, optional: Full path and name to save the file to. The default is None which export file in working_directory.
gridtypestr, optional: Type of the grid to export. The default is "Cartesian".
grid_centerlist, optional: The [x, y, z] coordinates for the center of the grid. The default is [0, 0, 0]. This parameter is disabled if gridtype= "Cartesian".
grid_startlist, optional: The [x, y, z] coordinates for the starting point of the grid. The default is [0, 0, 0].
grid_stoplist, optional: The [x, y, z] coordinates for the stopping point of the grid. The default is [0, 0, 0].
grid_steplist, optional: The [x, y, z] coordinates for the step size of the grid. The default is [0, 0, 0].
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:

str: Field file path when succeeded.

References

>>> oModule.EnterQty
>>> oModule.CopyNamedExprToStack
>>> oModule.CalcOp
>>> oModule.EnterQty
>>> oModule.EnterVol
>>> oModule.ExportOnGrid

Examples

>>> from pyaedt import Hfss
>>> hfss = Hfss()
>>> var = hfss.available_variations.nominal_w_values
>>> setup = "Setup1 : LastAdaptive"
>>> path = "Field.fld"
>>> hfss.post.export_field_file_on_grid("E", setup, var, path, 'Cartesian', [0, 0, 0],  intrinsics="8GHz")