HFSS3DLayoutBatchOptions

class pyedb.workflows.job_manager.backend.job_submission.HFSS3DLayoutBatchOptions(**data)

Bases: pydantic.BaseModel

HFSS-specific solver flags and environment settings.

Defaults are platform aware (Windows vs Linux).

Parameters:

create_starting_meshbool, optional

Generate initial mesh. Defaults to True.

default_process_prioritystr, optional

OS process priority. Defaults to "Normal".

enable_gpubool, optional

GPU acceleration. Defaults to False.

mpi_vendorstr, optional

MPI implementation. Auto-detected.

mpi_versionstr, optional

Version string. Defaults to "Default".

remote_spawn_commandstr, optional

Remote shell command. Auto-detected.

solve_adaptive_onlybool, optional

Skip frequency sweep. Defaults to False.

validate_onlybool, optional

Check setup only. Defaults to False.

temp_directorystr, optional

Scratch path. Auto-detected.

Overview

Methods

validate_fields	Validate all HFSS 3D layout options for correctness.
to_batch_options_dict	Convert options to HFSS batch options dictionary format.
to_batch_options_string	Return the Windows-safe string:

Attributes

create_starting_mesh
default_process_priority
enable_gpu
mpi_vendor
mpi_version
remote_spawn_command
solve_adaptive_only
validate_only
temp_directory

Import detail

from pyedb.workflows.job_manager.backend.job_submission import HFSS3DLayoutBatchOptions

Attribute detail

HFSS3DLayoutBatchOptions.create_starting_mesh: bool = False

HFSS3DLayoutBatchOptions.default_process_priority: str = 'Normal'

HFSS3DLayoutBatchOptions.enable_gpu: bool = False

HFSS3DLayoutBatchOptions.mpi_vendor: str = 'Intel'

HFSS3DLayoutBatchOptions.mpi_version: str = 'Default'

HFSS3DLayoutBatchOptions.remote_spawn_command: str = 'Scheduler'

HFSS3DLayoutBatchOptions.solve_adaptive_only: bool = False

HFSS3DLayoutBatchOptions.validate_only: bool = False

HFSS3DLayoutBatchOptions.temp_directory: str = None

Method detail

HFSS3DLayoutBatchOptions.validate_fields() → None

Validate all HFSS 3D layout options for correctness.

Performs comprehensive validation of HFSS-specific parameters including priority levels, MPI vendors, and directory paths.

Raises:

ValueError

If any parameter is invalid or unsupported.

HFSS3DLayoutBatchOptions.to_batch_options_dict() → Dict[str, str]

Convert options to HFSS batch options dictionary format.

Returns:

Dict[str, str]

Key-value pairs suitable for the -batchoptions switch.

HFSS3DLayoutBatchOptions.to_batch_options_string() → str

Return the Windows-safe string: “‘key1’=’value1’ ‘key2’=’value2’ …”