get_far_field_mesh

FfdSolutionData.get_far_field_mesh(quantity: str = 'RealizedGain', quantity_format: str = 'dB10') → UnstructuredGrid

Generate a PyVista UnstructuredGrid object that represents the far field mesh.

Parameters:

quantitystr, optional

Far field quantity to plot. The default is "RealizedGain". Available quantities are: "RealizedGain", "RealizedGain_Phi", "RealizedGain_Theta", "rEPhi", "rETheta", and "rETotal".

quantity_formatstr, optional

Conversion data function. Available functions are: "abs", "ang", "dB10", "dB20", "deg", "imag", "norm", and "real".

Returns:

Pyvista.Plotter

UnstructuredGrid object representing the far field mesh.

Examples

>>> from ansys.aedt.core.visualization.advanced.farfield_visualization import FfdSolutionData
>>> obj = FfdSolutionData()
>>> obj.get_far_field_mesh(quantity=1, quantity_format=1)