gplugins.elmer.run_capacitive_simulation_elmer

gplugins.elmer.run_capacitive_simulation_elmer#

gplugins.elmer.run_capacitive_simulation_elmer(component: Component, element_order: int = 1, n_processes: int = 1, layer_stack: LayerStack | None = None, material_spec: dict[str, dict[str, float | int]] | None = None, simulation_folder: Path | str | None = None, simulator_params: Mapping[str, Any] | None = None, mesh_parameters: dict[str, Any] | None = None, mesh_file: Path | str | None = None) → ElectrostaticResults[source]#

Run electrostatic finite element method simulations using Elmer. Returns the field solution and resulting capacitance matrix.

Note

You should have ElmerGrid, ElmerSolver and ElmerSolver_mpi and in your PATH.

Parameters:

  • component – Simulation environment as a gdsfactory component.

  • element_order – Order of polynomial basis functions. Higher is more accurate but takes more memory and time to run.

  • n_processes – Number of processes to use for parallelization

  • layer_stack – LayerStack defining defining what layers to include in the simulation and the material properties and thicknesses.

  • material_spec – RFMaterialSpec defining material parameters for the ones used in layer_stack.

  • simulation_folder – Directory for storing the simulation results. Default is a temporary directory.

  • simulator_params – Elmer-specific parameters. See template file for more details.

  • mesh_parameters – Keyword arguments to provide to get_mesh().

  • mesh_file – Path to a ready mesh to use. Useful for reusing one mesh file. By default a mesh is generated according to mesh_parameters.

Contents