Extensions¶
pypmj.extension_antenna¶
TODO: Explanation
Authors: Niko Nikolay, Carlo Barth
-
class
pypmj.extension_antenna.
FarFieldEvaluation
(simulation=None, direction=None, resolution=25, geometry='2D', subfolder='post_processes')¶ Bases:
object
TODO: Explanation
Parameters: - simulation (pypmj.core.Simulation) – The simulation instance for which the far field evaluation should be performed.
- direction ({'half_space_up', 'half_space_down', 'point_up',) – ‘point_down’, None} Direction specification for the far field evaluation. If None, the complete space will be considered. If ‘half_space_up’/ ‘half_space_down’, only the upper/lower half space will be considered. If ‘point_up’/’point_down’, a single evaluation point in upward/downward direction will be used. Note: If a point direction is used, the resolution parameter will be ignored.
- resolution (int, default 25) –
…
- geometry ({'2D', '3D'}, default '2D') –
…
- subfolder (str, default 'post_processes') – Folder name of the subfolder in the project working directory into which the post processing jcmp(t)-files should be written.
-
analyze_far_field
(**simulation_solve_kwargs)¶ Analyzes the far field of the current simulation. Checks if the expected .jcm-result files already exist and runs the simulation plus necessary post-processes if not. Afterwards, it executes the standard far field processing (using the _process_far_field_data-method).
-
load_far_field_data
(file_path)¶ Loads far field data from the .npz-file located at file_path.
-
save_far_field_data
(file_path, compressed=True)¶ Saves the far field data to the file at file_path using the numpy.savez (or numpy.savez_compressed method if compressed is True).
-
pypmj.extension_antenna.
far_field_processing_func
(pps)¶ This is the processing function for the far field evaluation as needed for the core.Simulation.process_results-method (which is also used be the run-methods). It reads the far field, refractive index and the evaluation points from the far field post-processes.
-
pypmj.extension_antenna.
read_jcm_far_field_tables
(jcm_files)¶ This is the processing function for the far field evaluation as needed for the core.Simulation.process_results-method (which is also used be the run-methods). It reads the far field, refractive index and the evaluation points from the far field post-processes.