kqcircuits.simulations.export.elmer.elmer_export

kqcircuits.simulations.export.elmer.elmer_export.copy_elmer_scripts_to_directory(path: pathlib.Path)[source]

Copies Elmer scripts into directory path.

Parameters

path – Location where to copy scripts folder.

kqcircuits.simulations.export.elmer.elmer_export.export_elmer_json(simulation: kqcircuits.simulations.simulation.Simulation, path: pathlib.Path, tool='capacitance', linear_system_method='bicgstab', p_element_order=1, frequency=5, mesh_size=None, workflow=None)[source]

Export Elmer simulation into json and gds files.

Parameters

  • simulation – The simulation to be exported.

  • path – Location where to write json.

  • tool (str) – Available: “capacitance” and “wave_equation” (Default: capacitance)

  • linear_system_method (str) – Available: ‘bicgstab’, ‘mg’ (Default: bicgstab)

  • p_element_order (int) – polynomial order of p-elements (Default: 1)

  • frequency – Units are in GHz. To set up multifrequency analysis, use list of numbers.

  • mesh_size (dict) – Parameters to determine mesh element sizes

  • workflow (dict) – Parameters for simulation workflow

Returns

Path to exported json file.

kqcircuits.simulations.export.elmer.elmer_export.export_elmer_script(json_filenames, path: pathlib.Path, workflow=None, file_prefix='simulation', script_file='scripts/run.py')[source]

Create script files for running one or more simulations. Create also a main script to launch all the simulations at once.

Parameters

  • json_filenames – List of paths to json files to be included into the script.

  • path – Location where to write the script file.

  • workflow (dict) – Parameters for simulation workflow

  • file_prefix – Name of the script file to be created.

  • script_file – Name of the script file to run.

Returns

Path of exported main script file

kqcircuits.simulations.export.elmer.elmer_export.export_elmer(simulations: [], path: pathlib.Path, tool='capacitance', linear_system_method='bicgstab', p_element_order=1, frequency=5, file_prefix='simulation', script_file='scripts/run.py', mesh_size=None, workflow=None, skip_errors=False)[source]

Exports an elmer simulation model to the simulation path.

Parameters

  • simulations (list(Simulation)) – list of all the simulations

  • path (Path) – Location where to output the simulation model

  • tool (str) – Available: “capacitance” and “wave_equation” (Default: capacitance)

  • linear_system_method (str) – Available: ‘bicgstab’, ‘mg’ (Default: bicgstab)

  • p_element_order (int) – polynomial order of p-elements (Default: 1)

  • frequency – Units are in GHz. To set up multifrequency analysis, use list of numbers.

  • file_prefix – File prefix of the script file to be created.

  • script_file – Name of the script file to run.

  • mesh_size (dict) – Parameters to determine mesh element sizes

  • workflow (dict) – Parameters for simulation workflow

  • skip_errors (bool) –

    Skip simulations that cause errors. (Default: False)

    Warning

    Use this carefully, some of your simulations might not make sense physically and you might end up wasting time on bad simulations.

Returns

Path to exported script file.

../_images/kqcircuits.simulations.export.elmer.elmer_export.png