export_field_file#

PostProcessor.export_field_file(quantity, solution=None, variations=None, output_dir=None, assignment='AllObjects', objects_type='Vol', intrinsics=None, phase=None, sample_points_file=None, sample_points=None, export_with_sample_points=True, reference_coordinate_system='Global', export_in_si_system=True, export_field_in_reference=True)[source]#

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

Parameters:

quantity: Name of the quantity to export. For example, "Temp".
solutionstr, optional: Name of the solution in the format "solution: sweep". The default is None.
variationsdict, optional: Dictionary of all variation variables with their values. The default is None.
output_dirstr, optional: Full path and name to save the file to. The default is None which export file in working_directory.
assignmentstr, optional: List of objects to export. The default is "AllObjects".
objects_typestr, optional: Type of objects to export. The default is "Vol". Options are "Surf" for surface and "Vol" for volume.
intrinsicsstr, optional: This parameter is mandatory for a frequency or transient field calculation. The default is None.
phasestr, optional: Field phase. The default is None.
sample_points_filestr, optional: Name of the file with sample points. The default is None.
sample_pointslist, optional: List of the sample points. The default is None.
export_with_sample_pointsbool, optional: Whether to include the sample points in the file to export. The default is True.
reference_coordinate_systemstr, optional: Reference coordinate system in the file to export. The default is "Global".
export_in_si_systembool, optional: Whether the provided sample points are defined in the SI system or model units. The default is True.
export_field_in_referencebool, optional: Whether to export the field in reference coordinate system. The default is True.

Returns:

bool: True when successful, False when failed.

References

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