Runs and returns the simulation and memory requirements for the simulation setup.
|
Syntax
|
Description
|
|
out=runsystemcheck;
|
Returns a struct that contains the simulation and memory requirements for the simulation setup for CPU simulations.
|
|
out=runsystemcheck("FDTD","CPU")
|
Returns a struct that contains the simulation and memory requirements for the simulation setup for CPU simulations. Identical to the version without any arguments.
|
|
out=runsystemcheck("FDTD","GPU")
|
Returns a struct that contains the simulation and memory requirements for the simulation setup for GPU simulations.
|
The output structure for the CPU system check will have the following fields:
|
Field
|
Description
|
|
Approximate_Memory_Requirements
|
Structure containing approximate memory requirements with the following fields:
- Alert: Any alerts with regards to estimation.
- Data_Collection_Bytes: Estimation of data collection memory in bytes.
- FSP_Saved_Monitor_Data_Bytes: Estimation of memory required to save monitor data to project .fsp file in bytes.
- Initialization_and_Mesh_Bytes: Estimation of initialization and meshing memory in bytes.
- Running_Simulation_Bytes: Estimation of memory needed to run simulation in bytes.
|
|
Frequency_WaveLength_Settings
|
Structure showing simulation bandwidth information with the following fields:
- Bandwidth_Source: Where the bandwidth values are detected from, either from the simulation region or from source settings.
- Simulation_Bandwidth: Structure containing information about simulation frequency and wavelength with the following fields for the bandwidth source above:
- Alert: Any alert with regards to estimation.
- Maximum_Frequency_THz: Maximum frequency in terahertz (THz).
- Maximum_Wavelength_Micrometer: Maximum wavelength in micrometers.
- Minimum_Frequency_THz: Minimum frequency in THz.
- Minimum_Wavelength_Micrometer: Minimum wavelength in micrometers.
- Simulation_Frequency_THz: Simulation center frequency in THz.
- Simulation_Wavelength_Micrometer: Simulation center wavelength in THz.
|
|
Geometry
|
Displays any errors related to geometry of the simulation structure, empty if there are no errors.
|
| Materials
|
Structure showing material name and index fitting information with the following fields, one for each material:
- Material_Name: Name of material
- RMS_Error: Root mean square error of index fit in the simulation bandwidth.
|
| Memory_Details |
Structure showing memory estimation details with the following fields:
- Electromagnetic_Fields_and_Refractive_Index: Memory needed for electromagnetic fields and refractive index in bytes.
- Electromagnetic_Fields_and_Refractive_Index_Percent: Percentage of total recommended memory electromagnetic fields and refractive index takes up.
- Field_Type: The field type for the memory estimates above, either electromagnetic field and refractive index, or complex electromagnetic field and refractive index.
- Miscellaneous_Memory_Bytes: Memory needed for all operations other than electromagnetic fields, index, monitors, and sources, in bytes.
- Miscellaneous_Memory_Percent: Percentage of total recommended memory miscellaneous operations takes up.
|
| Memory_Recommended_Bytes |
Recommended memory in bytes. |
| Mesh_Override |
Displays mesh override warnings, empty if there are no warnings. |
| Total_FDTD_Yee_Nodes |
Total number of Yee nodes in the simulation in millions of nodes. |
The output structure for the GPU system check will have the following fields:
|
Field
|
Description
|
| Approximate_GPU_Memory_Requirements |
Structure containing approximate video RAM (VRAM) requirements for GPU simulations with the following fields:
- Maximum_Bytes: Maximum estimated memory in bytes
- Minimum_Bytes: Minimum estimated memory in bytes
|
| GPU_Memory_Details |
Structure with details for estimated GPU memory requirements with the following fields:
- Minimum: Structure with estimated minimum VRAM requirement for various components of the simulation with the following fields:
- Electromagnetic_And_Auxiliary_Fields_Bytes: Minimum estimated memory needed for main and auxiliary fields in bytes.
- Grid_And_Material_Coefficients_Bytes: Minimum estimated memory needed for grid and material coefficients in bytes.
- Monitors_Bytes: Minimum estimated memory needed for all monitors in bytes.
- Sources_Bytes: Minimum estimated memory needed for all sources in bytes.
- Maximum: Structure with estimated minimum VRAM requirement for various components of the simulation with the following fields:
- Electromagnetic_And_Auxiliary_Fields_Bytes: Maximum estimated memory needed for main and auxiliary fields in bytes.
- Grid_And_Material_Coefficients_Bytes: Maximum estimated memory needed for grid and material coefficients in bytes.
- Monitors_Bytes: Maximum estimated memory needed for all monitors in bytes.
- Sources_Bytes: Maximum estimated memory needed for all sources in bytes.
|
Example
The following script command will construct a simple FDTD simulation and check its memory requirements then save the simulation and memory requirements to a Json file:
addfdtd;
addrect;
a = runsystemcheck;
jsonsave("memory_requirement.json");
The contents of the Json file contains the same information shown in the "Simulation and Memory Report".
See Also
List of commands