## On this page

  

 

 # ZOSAPI.Tools Namespace Reference

 Last update: 17.07.2025 

## <a id="namespaces" name="namespaces"></a>Namespaces

namespace [FileManager](namespace_z_o_s_a_p_i_1_1_tools_1_1_file_manager.xhtml) namespace [General](namespace_z_o_s_a_p_i_1_1_tools_1_1_general.xhtml) namespace [Layouts](namespace_z_o_s_a_p_i_1_1_tools_1_1_layouts.xhtml) namespace [Optimization](namespace_z_o_s_a_p_i_1_1_tools_1_1_optimization.xhtml) namespace [OptimizationTools](namespace_z_o_s_a_p_i_1_1_tools_1_1_optimization_tools.xhtml) namespace [RayTrace](namespace_z_o_s_a_p_i_1_1_tools_1_1_ray_trace.xhtml) namespace [Tolerancing](namespace_z_o_s_a_p_i_1_1_tools_1_1_tolerancing.xhtml) ## <a id="nested-classes" name="nested-classes"></a>Classes

interface [IAPIUtilities](interface_z_o_s_a_p_i_1_1_tools_1_1_i_a_p_i_utilities.xhtml) interface [IConvertToNSCGroup](interface_z_o_s_a_p_i_1_1_tools_1_1_i_convert_to_n_s_c_group.xhtml) Interfaces and methods for converting the sequential surfaces to a non-sequential group. This interface can be accessed via the IOpticalSystemTools interface. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_convert_to_n_s_c_group.xhtml#details)  
 interface [ICriticalRaysetGenerator](interface_z_o_s_a_p_i_1_1_tools_1_1_i_critical_rayset_generator.xhtml) Interfaces and methods for generating a 'critical rayset'; these rays can be used after converting to non-sequential in order to verify that the conversion did not fundamentally alter the geometries. This interface can be accessed via the IOpticalSystemTools interface. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_critical_rayset_generator.xhtml#details)  
 interface [IDesignLockdown](interface_z_o_s_a_p_i_1_1_tools_1_1_i_design_lockdown.xhtml) Interfaces and methods for validating a sequential design, prior to manufacturing or conversion to non-sequential. This interface can be accessed via the IOpticalSystemTools interface. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_design_lockdown.xhtml#details)  
 interface [IExportToSpeosLensSystem](interface_z_o_s_a_p_i_1_1_tools_1_1_i_export_to_speos_lens_system.xhtml) Interface to access the "Export to Speos Lens System" tool. This interface can be accessed via the IOpticalSystemTools interface. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_export_to_speos_lens_system.xhtml#details)  
 interface [IExportToSpeosWhitebox](interface_z_o_s_a_p_i_1_1_tools_1_1_i_export_to_speos_whitebox.xhtml) interface [IFileManager](interface_z_o_s_a_p_i_1_1_tools_1_1_i_file_manager.xhtml) interface [IHPCSettings](interface_z_o_s_a_p_i_1_1_tools_1_1_i_h_p_c_settings.xhtml) interface [IInternalBirefringenceData](interface_z_o_s_a_p_i_1_1_tools_1_1_i_internal_birefringence_data.xhtml) interface [IInternalBirefringenceParameter](interface_z_o_s_a_p_i_1_1_tools_1_1_i_internal_birefringence_parameter.xhtml) interface [IInternalTransmissionData](interface_z_o_s_a_p_i_1_1_tools_1_1_i_internal_transmission_data.xhtml) interface [IInternalTransmissionParameter](interface_z_o_s_a_p_i_1_1_tools_1_1_i_internal_transmission_parameter.xhtml) interface [ILayouts](interface_z_o_s_a_p_i_1_1_tools_1_1_i_layouts.xhtml) interface [IMaterialsCatalog](interface_z_o_s_a_p_i_1_1_tools_1_1_i_materials_catalog.xhtml) interface [IMFCalculator](interface_z_o_s_a_p_i_1_1_tools_1_1_i_m_f_calculator.xhtml) Interfaces and methods for calculating the current Merit Function value. This interface can be accessed via the IOpticalSystemTools interface. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_m_f_calculator.xhtml#details)  
 interface [IOpticalSystemTools](interface_z_o_s_a_p_i_1_1_tools_1_1_i_optical_system_tools.xhtml) Methods to run various system-wide tools. This interface can be accessed via the IOpticalSystem interface. Note that only one ISystemTool can be open at a time; the previous tool must be closed using ISystemTool.Close before a new one can be opened. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_optical_system_tools.xhtml#details)  
 interface [IShadedModelTriangleList](interface_z_o_s_a_p_i_1_1_tools_1_1_i_shaded_model_triangle_list.xhtml) interface [IShadedModelVisualizationExport](interface_z_o_s_a_p_i_1_1_tools_1_1_i_shaded_model_visualization_export.xhtml) Interfaces and methods for getting a set of triangles for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_shaded_model_visualization_export.xhtml#details)  
 interface [ISystemTool](interface_z_o_s_a_p_i_1_1_tools_1_1_i_system_tool.xhtml) Base interface for all system tools. See IOpticalSystemTools for access to specific tools. [More...](interface_z_o_s_a_p_i_1_1_tools_1_1_i_system_tool.xhtml#details)  
 ## <a id="enum-members" name="enum-members"></a>Enumerations

enum [RayPatternOption](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201) {   
 [XyFan](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201a540aea6471960421e87985bb9e0922b2) = 0 , [XFan](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201ad03771938370f42deb52f4c7bca9d2b9) = 1 , [YFan](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201a116b05b870a7644f77e4f64ae6505a39) = 2 , [ChiefAndRing](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201a4ee03e34d9aed688193ce0801e444f51) = 3 ,   
 [List](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201a4ee29ca12c7d126654bd0e5275de6135) = 4 , [Grid](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201a5174d1309f275ba6f275db3af9eb3e18) = 6 , [ChiefAndMarginals](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201a2afd4f66b86eaf8d35b93688b7723801) = 8   
 } enum [CriticalRayType](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05) {   
 [Chief](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05aba23ed47917bf1a079d513b1df2395de) = 0 , [Marginal](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05a39e861530e72b78a7b23c9cae1356549) = 1 , [Grid](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05a5174d1309f275ba6f275db3af9eb3e18) = 2 , [Ring](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05ad4db177c94738b72bf9ce61e988ab1f1) = 3 ,   
 [Y\_Fan](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05a21cec96214ef315cf04d733fb2c38a95) = 4 , [X\_Fan](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05a44b132c5df4f4bf73c698844900313b6) = 5 , [XY\_Fan](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05ae5d84fd236078441fa0e561be2f79b44) = 6 , [List](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05a4ee29ca12c7d126654bd0e5275de6135) = 7   
 } enum [MaterialFormulas](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76) {   
 [Schott](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76ae663d5551c3f46017ffd36f2213e410d) = 1 , [Sellmeier1](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76ae01e08b54072a2bd2327bd024a970462) = 2 , [Herzberger](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a870d03648d2e4ca0dfe72a6c04333766) = 3 , [Sellmeier2](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a30ea6845100160865f59907276c4b656) = 4 ,   
 [Conrady](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a6101fca39ef22c05f86d8343b0868316) = 5 , [Sellmeier3](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a99763afb688952a43755bdf49a124763) = 6 , [Handbook1](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a40a69f375d505d63a1fd5e0f177b89be) = 7 , [Handbook2](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a088f3386a2c36a846e4533a7e228e824) = 8 ,   
 [Sellmeier4](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76aa056859501637442a3ce09ab33ee5626) = 9 , [Extended](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76af23578fcd2a868168854ab714e7de537) = 10 , [Sellmeier5](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a0ac331dfc7c675bdc659de25427e9b40) = 11 , [Extended2](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a047354cd566c210fb44667dc65ab1723) = 12 ,   
 [Extended3](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76a2fd51613b49139ccb46df3cbc5391726) = 13   
 } enum [MaterialStatuses](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a7862ff305a54047124a57804062940ad) {   
 [Standard](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a7862ff305a54047124a57804062940adaeb6d8ae6f20283755b339c0dc273988b) = 0 , [Preferred](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a7862ff305a54047124a57804062940adaa054ccb4ff684c73cbc2d272d45e32df) = 1 , [Obsolete](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a7862ff305a54047124a57804062940adaec30c235d0eb792797af1aa1d11759a7) = 2 , [Special](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a7862ff305a54047124a57804062940adab4c2b550635fe54fd29f2b64dfaca55d) = 3 ,   
 [Melt](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a7862ff305a54047124a57804062940ada99876091c84fcbe03a59a4d01be7abe7) = 4   
 } enum [VertexOrder](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a854f4abc9c04e1b2c8fe5fe01b8a8adc) { [First](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a854f4abc9c04e1b2c8fe5fe01b8a8adca7fb55ed0b7a30342ba6da306428cae04), [Second](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a854f4abc9c04e1b2c8fe5fe01b8a8adcac22cf8376b1893dcfcef0649fe1a7d87), [Third](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a854f4abc9c04e1b2c8fe5fe01b8a8adca168909c0b6f1dfbd48f679d47059c1d6) } enum [HPCEnvironments](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a07560c2d76e9760689f2313436187b1b) { [OnPremise](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a07560c2d76e9760689f2313436187b1ba64ec427e32c61e4b5d78816bcd95a580) = 0 , [AWSKubernetes](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a07560c2d76e9760689f2313436187b1bac527e8f092d6f9aaf10b46666a268ba4), [AzureKubernetes](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a07560c2d76e9760689f2313436187b1ba79f07e794e6b7592f3cc7d32faf9ac0d) } enum [HPCNodeSize](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8) {   
 [Default](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8a7a1920d61156abc05a60135aefe8bc67) = 0 , [Tiny](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8a383c05bda6f030a44990d354b24f3338) = 1 , [Small](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8a2660064e68655415da2628c2ae2f7592) = 2 , [Medium](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8a87f8a6ab85c9ced3702b4ea641ad4bb5) = 3 ,   
 [Large](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8a3a69b34ce86dacb205936a8094f6c743) = 4 , [XLarge](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8a7e3974f53d1c28e788066dbaf5377797) = 5   
 } enum [HPCRunState](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473e) {   
 [NotRunning](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473eae457ff7a83d0a8681fa483f898788515) = 0 , [Initializing](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473ea32b169f72b293ef80d35435e9894f8e2), [ClusterAllocating](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473ea7713394dcf2b71c2b590f0da1c2e5d39), [UploadingData](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473ea7393bdf28cf77c0c25f059a077cd7e53),   
 [Queued](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473ea7b2f31b90fe1c2cc33a52233c1925df3), [RunStarting](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473eaffe7be2ae14ada651350b8ed09de8374), [WaitingForResults](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473ea0bb0640d0b88e29c97aa602db76d3b7c), [Complete](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473eaae94f80b3ce82062a5dd7815daa04f9d)  
 } enum [RunStatus](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3a955211d48653a7f845f495982c2e11) { [Completed](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3a955211d48653a7f845f495982c2e11a07ca5050e697392c9ed47e6453f1453f), [FailedToStart](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3a955211d48653a7f845f495982c2e11a4ace348995a664f8a904bc8263043797), [TimedOut](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3a955211d48653a7f845f495982c2e11a9541eb2348d883dd8e32ae0420274c4c), [InvalidTimeout](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3a955211d48653a7f845f495982c2e11ac794d9d363bf315121816d23896ad098) } <a id="details" name="details"></a>## Detailed Description

Usage (see [Example 15](page_ex15.xhtml) for a full sample)

C#

 // remove all variables and add a F# solve on last surface radius

 ILensDataEditor TheLDE = TheSystem.LDE;

 [IOpticalSystemTools](interface_z_o_s_a_p_i_1_1_tools_1_1_i_optical_system_tools.xhtml) tools = TheSystem.Tools;

 tools.[RemoveAllVariables](interface_z_o_s_a_p_i_1_1_tools_1_1_i_optical_system_tools.xhtml#a74ba97071e2838cebea60050bc5353a2)();

 ILDERow Surface_Last = TheLDE.GetSurfaceAt(TheLDE.NumberOfSurfaces - 2);

 ISolveData Solver = Surface_Last.RadiusCell.CreateSolveType([ZOSAPI](namespace_z_o_s_a_p_i.xhtml).[Editors](namespace_z_o_s_a_p_i_1_1_editors.xhtml).SolveType.FNumber);

 Solver._S_FNumber.FNumber = 3.1415;

 Surface_Last.RadiusCell.SetSolveData(Solver);

 SampleFile = System.IO.Path.Combine(TheApplication.SamplesDir, @"API\\CS\\e15\_Seq\_Optimization\\OptimizedFile1.zos");

 TheSystem.SaveAs(SampleFile);

[ZOSAPI.Tools.IOpticalSystemTools](interface_z_o_s_a_p_i_1_1_tools_1_1_i_optical_system_tools.xhtml)

Methods to run various system-wide tools. This interface can be accessed via the IOpticalSystem inter...

**Definition:** Tools.cs:107



[ZOSAPI.Tools.IOpticalSystemTools.RemoveAllVariables](interface_z_o_s_a_p_i_1_1_tools_1_1_i_optical_system_tools.xhtml#a74ba97071e2838cebea60050bc5353a2)

bool RemoveAllVariables()

Removes all variables in the system.



[ZOSAPI.Editors](namespace_z_o_s_a_p_i_1_1_editors.xhtml)

**Definition:** InterfacesEditors.cs:12



[ZOSAPI](namespace_z_o_s_a_p_i.xhtml)

The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...

**Definition:** IAS_FieldCurvatureAndDistortion.cs:5





 C++

 // remove all variables and add a F# solve on last surface radius

 ILensDataEditorPtr TheLDE = TheSystem-&gt;LDE;

 //IOpticalSystemTools

 IOpticalSystemToolsPtr tools = TheSystem-&gt;Tools;

 tools-&gt;RemoveAllVariables();

 ILDERowPtr Surface_Last = TheLDE-&gt;GetSurfaceAt(TheLDE-&gt;NumberOfSurfaces - 2);

 ISolveDataPtr Solver = Surface_Last-&gt;RadiusCell-&gt;CreateSolveType(SolveType::SolveType_FNumber);

 Solver-&gt;_S_FNumber-&gt;FNumber = 3.1415;

 Surface_Last-&gt;RadiusCell-&gt;SetSolveData(Solver);

 SampleFile = _bstr_t(TheApplication-&gt;SamplesDir) + "\\\\API\\\\\\Seq\_Optimization\\\\\\OptimizedFile1.zos";

 TheSystem-&gt;SaveAs(SampleFile);



 Matlab

 % remove all variables and add a F# solve on last surface radius

 TheLDE = TheSystem.LDE;

 tools = TheSystem.Tools;

 tools.RemoveAllVariables();

 Surface_Last = TheLDE.GetSurfaceAt(TheLDE.NumberOfSurfaces - 2);

 Solver = Surface_Last.RadiusCell.CreateSolveType([ZOSAPI](namespace_z_o_s_a_p_i.xhtml).[Editors](namespace_z_o_s_a_p_i_1_1_editors.xhtml).SolveType.FNumber);

 Solver.S_FNumber_.FNumber = 3.1415;

 Surface_Last.RadiusCell.SetSolveData(Solver);

 SampleFile = System.String.Concat(TheApplication.SamplesDir, '\\API\\Matlab\\e15\_Seq\_Optimization\\OptimizedFile1.zos');

 TheSystem.SaveAs(SampleFile);



 Python

 \# remove all variables and add a F# solve on last surface radius

 TheLDE = TheSystem.LDE

 \#IOpticalSystemTools

 tools = TheSystem.Tools

 tools.RemoveAllVariables()

 Surface_Last = TheLDE.GetSurfaceAt(TheLDE.NumberOfSurfaces - 2)

 Solver = Surface_Last.RadiusCell.CreateSolveType(ZOSAPI.Editors.SolveType.FNumber)

 Solver._S_FNumber.FNumber = 3.1415

 Surface_Last.RadiusCell.SetSolveData(Solver)

 SampleFile = TheApplication.SamplesDir + '\\\\API\\\\Python\\\\e15\_Seq\_Optimization\\\\OptimizedFile1.zos'

 TheSystem.SaveAs(SampleFile)





## Enumeration Type Documentation

<a id="a8bbc6b3e36c64d13ead926a2f451bb05" name="a8bbc6b3e36c64d13ead926a2f451bb05"></a>## [◆ ](#a8bbc6b3e36c64d13ead926a2f451bb05)CriticalRayType

 enum [ZOSAPI.Tools.CriticalRayType](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a8bbc6b3e36c64d13ead926a2f451bb05)

Enumerator<a id="a8bbc6b3e36c64d13ead926a2f451bb05aba23ed47917bf1a079d513b1df2395de" name="a8bbc6b3e36c64d13ead926a2f451bb05aba23ed47917bf1a079d513b1df2395de"></a>Chief <a id="a8bbc6b3e36c64d13ead926a2f451bb05a39e861530e72b78a7b23c9cae1356549" name="a8bbc6b3e36c64d13ead926a2f451bb05a39e861530e72b78a7b23c9cae1356549"></a>Marginal <a id="a8bbc6b3e36c64d13ead926a2f451bb05a5174d1309f275ba6f275db3af9eb3e18" name="a8bbc6b3e36c64d13ead926a2f451bb05a5174d1309f275ba6f275db3af9eb3e18"></a>Grid <a id="a8bbc6b3e36c64d13ead926a2f451bb05ad4db177c94738b72bf9ce61e988ab1f1" name="a8bbc6b3e36c64d13ead926a2f451bb05ad4db177c94738b72bf9ce61e988ab1f1"></a>Ring <a id="a8bbc6b3e36c64d13ead926a2f451bb05a21cec96214ef315cf04d733fb2c38a95" name="a8bbc6b3e36c64d13ead926a2f451bb05a21cec96214ef315cf04d733fb2c38a95"></a>Y\_Fan <a id="a8bbc6b3e36c64d13ead926a2f451bb05a44b132c5df4f4bf73c698844900313b6" name="a8bbc6b3e36c64d13ead926a2f451bb05a44b132c5df4f4bf73c698844900313b6"></a>X\_Fan <a id="a8bbc6b3e36c64d13ead926a2f451bb05ae5d84fd236078441fa0e561be2f79b44" name="a8bbc6b3e36c64d13ead926a2f451bb05ae5d84fd236078441fa0e561be2f79b44"></a>XY\_Fan <a id="a8bbc6b3e36c64d13ead926a2f451bb05a4ee29ca12c7d126654bd0e5275de6135" name="a8bbc6b3e36c64d13ead926a2f451bb05a4ee29ca12c7d126654bd0e5275de6135"></a>List 



<a id="a07560c2d76e9760689f2313436187b1b" name="a07560c2d76e9760689f2313436187b1b"></a>## [◆ ](#a07560c2d76e9760689f2313436187b1b)HPCEnvironments

 enum [ZOSAPI.Tools.HPCEnvironments](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a07560c2d76e9760689f2313436187b1b)

Enumerator<a id="a07560c2d76e9760689f2313436187b1ba64ec427e32c61e4b5d78816bcd95a580" name="a07560c2d76e9760689f2313436187b1ba64ec427e32c61e4b5d78816bcd95a580"></a>OnPremise <a id="a07560c2d76e9760689f2313436187b1bac527e8f092d6f9aaf10b46666a268ba4" name="a07560c2d76e9760689f2313436187b1bac527e8f092d6f9aaf10b46666a268ba4"></a>AWSKubernetes <a id="a07560c2d76e9760689f2313436187b1ba79f07e794e6b7592f3cc7d32faf9ac0d" name="a07560c2d76e9760689f2313436187b1ba79f07e794e6b7592f3cc7d32faf9ac0d"></a>AzureKubernetes 



<a id="af9b19fe46bcaaed03add101dc63d99f8" name="af9b19fe46bcaaed03add101dc63d99f8"></a>## [◆ ](#af9b19fe46bcaaed03add101dc63d99f8)HPCNodeSize

 enum [ZOSAPI.Tools.HPCNodeSize](namespace_z_o_s_a_p_i_1_1_tools.xhtml#af9b19fe46bcaaed03add101dc63d99f8)

Enumerator<a id="af9b19fe46bcaaed03add101dc63d99f8a7a1920d61156abc05a60135aefe8bc67" name="af9b19fe46bcaaed03add101dc63d99f8a7a1920d61156abc05a60135aefe8bc67"></a>Default <a id="af9b19fe46bcaaed03add101dc63d99f8a383c05bda6f030a44990d354b24f3338" name="af9b19fe46bcaaed03add101dc63d99f8a383c05bda6f030a44990d354b24f3338"></a>Tiny <a id="af9b19fe46bcaaed03add101dc63d99f8a2660064e68655415da2628c2ae2f7592" name="af9b19fe46bcaaed03add101dc63d99f8a2660064e68655415da2628c2ae2f7592"></a>Small <a id="af9b19fe46bcaaed03add101dc63d99f8a87f8a6ab85c9ced3702b4ea641ad4bb5" name="af9b19fe46bcaaed03add101dc63d99f8a87f8a6ab85c9ced3702b4ea641ad4bb5"></a>Medium <a id="af9b19fe46bcaaed03add101dc63d99f8a3a69b34ce86dacb205936a8094f6c743" name="af9b19fe46bcaaed03add101dc63d99f8a3a69b34ce86dacb205936a8094f6c743"></a>Large <a id="af9b19fe46bcaaed03add101dc63d99f8a7e3974f53d1c28e788066dbaf5377797" name="af9b19fe46bcaaed03add101dc63d99f8a7e3974f53d1c28e788066dbaf5377797"></a>XLarge 



<a id="a3680696b4d19238a953f6d7d3ff2473e" name="a3680696b4d19238a953f6d7d3ff2473e"></a>## [◆ ](#a3680696b4d19238a953f6d7d3ff2473e)HPCRunState

 enum [ZOSAPI.Tools.HPCRunState](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3680696b4d19238a953f6d7d3ff2473e)

Enumerator<a id="a3680696b4d19238a953f6d7d3ff2473eae457ff7a83d0a8681fa483f898788515" name="a3680696b4d19238a953f6d7d3ff2473eae457ff7a83d0a8681fa483f898788515"></a>NotRunning <a id="a3680696b4d19238a953f6d7d3ff2473ea32b169f72b293ef80d35435e9894f8e2" name="a3680696b4d19238a953f6d7d3ff2473ea32b169f72b293ef80d35435e9894f8e2"></a>Initializing <a id="a3680696b4d19238a953f6d7d3ff2473ea7713394dcf2b71c2b590f0da1c2e5d39" name="a3680696b4d19238a953f6d7d3ff2473ea7713394dcf2b71c2b590f0da1c2e5d39"></a>ClusterAllocating <a id="a3680696b4d19238a953f6d7d3ff2473ea7393bdf28cf77c0c25f059a077cd7e53" name="a3680696b4d19238a953f6d7d3ff2473ea7393bdf28cf77c0c25f059a077cd7e53"></a>UploadingData <a id="a3680696b4d19238a953f6d7d3ff2473ea7b2f31b90fe1c2cc33a52233c1925df3" name="a3680696b4d19238a953f6d7d3ff2473ea7b2f31b90fe1c2cc33a52233c1925df3"></a>Queued <a id="a3680696b4d19238a953f6d7d3ff2473eaffe7be2ae14ada651350b8ed09de8374" name="a3680696b4d19238a953f6d7d3ff2473eaffe7be2ae14ada651350b8ed09de8374"></a>RunStarting <a id="a3680696b4d19238a953f6d7d3ff2473ea0bb0640d0b88e29c97aa602db76d3b7c" name="a3680696b4d19238a953f6d7d3ff2473ea0bb0640d0b88e29c97aa602db76d3b7c"></a>WaitingForResults <a id="a3680696b4d19238a953f6d7d3ff2473eaae94f80b3ce82062a5dd7815daa04f9d" name="a3680696b4d19238a953f6d7d3ff2473eaae94f80b3ce82062a5dd7815daa04f9d"></a>Complete 



<a id="a6df11e2844df49dda60584b8a9820c76" name="a6df11e2844df49dda60584b8a9820c76"></a>## [◆ ](#a6df11e2844df49dda60584b8a9820c76)MaterialFormulas

 enum [ZOSAPI.Tools.MaterialFormulas](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a6df11e2844df49dda60584b8a9820c76)

Enumerator<a id="a6df11e2844df49dda60584b8a9820c76ae663d5551c3f46017ffd36f2213e410d" name="a6df11e2844df49dda60584b8a9820c76ae663d5551c3f46017ffd36f2213e410d"></a>Schott <a id="a6df11e2844df49dda60584b8a9820c76ae01e08b54072a2bd2327bd024a970462" name="a6df11e2844df49dda60584b8a9820c76ae01e08b54072a2bd2327bd024a970462"></a>Sellmeier1 <a id="a6df11e2844df49dda60584b8a9820c76a870d03648d2e4ca0dfe72a6c04333766" name="a6df11e2844df49dda60584b8a9820c76a870d03648d2e4ca0dfe72a6c04333766"></a>Herzberger <a id="a6df11e2844df49dda60584b8a9820c76a30ea6845100160865f59907276c4b656" name="a6df11e2844df49dda60584b8a9820c76a30ea6845100160865f59907276c4b656"></a>Sellmeier2 <a id="a6df11e2844df49dda60584b8a9820c76a6101fca39ef22c05f86d8343b0868316" name="a6df11e2844df49dda60584b8a9820c76a6101fca39ef22c05f86d8343b0868316"></a>Conrady <a id="a6df11e2844df49dda60584b8a9820c76a99763afb688952a43755bdf49a124763" name="a6df11e2844df49dda60584b8a9820c76a99763afb688952a43755bdf49a124763"></a>Sellmeier3 <a id="a6df11e2844df49dda60584b8a9820c76a40a69f375d505d63a1fd5e0f177b89be" name="a6df11e2844df49dda60584b8a9820c76a40a69f375d505d63a1fd5e0f177b89be"></a>Handbook1 <a id="a6df11e2844df49dda60584b8a9820c76a088f3386a2c36a846e4533a7e228e824" name="a6df11e2844df49dda60584b8a9820c76a088f3386a2c36a846e4533a7e228e824"></a>Handbook2 <a id="a6df11e2844df49dda60584b8a9820c76aa056859501637442a3ce09ab33ee5626" name="a6df11e2844df49dda60584b8a9820c76aa056859501637442a3ce09ab33ee5626"></a>Sellmeier4 <a id="a6df11e2844df49dda60584b8a9820c76af23578fcd2a868168854ab714e7de537" name="a6df11e2844df49dda60584b8a9820c76af23578fcd2a868168854ab714e7de537"></a>Extended <a id="a6df11e2844df49dda60584b8a9820c76a0ac331dfc7c675bdc659de25427e9b40" name="a6df11e2844df49dda60584b8a9820c76a0ac331dfc7c675bdc659de25427e9b40"></a>Sellmeier5 <a id="a6df11e2844df49dda60584b8a9820c76a047354cd566c210fb44667dc65ab1723" name="a6df11e2844df49dda60584b8a9820c76a047354cd566c210fb44667dc65ab1723"></a>Extended2 <a id="a6df11e2844df49dda60584b8a9820c76a2fd51613b49139ccb46df3cbc5391726" name="a6df11e2844df49dda60584b8a9820c76a2fd51613b49139ccb46df3cbc5391726"></a>Extended3 



<a id="a7862ff305a54047124a57804062940ad" name="a7862ff305a54047124a57804062940ad"></a>## [◆ ](#a7862ff305a54047124a57804062940ad)MaterialStatuses

 enum [ZOSAPI.Tools.MaterialStatuses](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a7862ff305a54047124a57804062940ad)

Enumerator<a id="a7862ff305a54047124a57804062940adaeb6d8ae6f20283755b339c0dc273988b" name="a7862ff305a54047124a57804062940adaeb6d8ae6f20283755b339c0dc273988b"></a>Standard <a id="a7862ff305a54047124a57804062940adaa054ccb4ff684c73cbc2d272d45e32df" name="a7862ff305a54047124a57804062940adaa054ccb4ff684c73cbc2d272d45e32df"></a>Preferred <a id="a7862ff305a54047124a57804062940adaec30c235d0eb792797af1aa1d11759a7" name="a7862ff305a54047124a57804062940adaec30c235d0eb792797af1aa1d11759a7"></a>Obsolete <a id="a7862ff305a54047124a57804062940adab4c2b550635fe54fd29f2b64dfaca55d" name="a7862ff305a54047124a57804062940adab4c2b550635fe54fd29f2b64dfaca55d"></a>Special <a id="a7862ff305a54047124a57804062940ada99876091c84fcbe03a59a4d01be7abe7" name="a7862ff305a54047124a57804062940ada99876091c84fcbe03a59a4d01be7abe7"></a>Melt 



<a id="aa0eba80920a97b8b2b3d256e0fe63201" name="aa0eba80920a97b8b2b3d256e0fe63201"></a>## [◆ ](#aa0eba80920a97b8b2b3d256e0fe63201)RayPatternOption

 enum [ZOSAPI.Tools.RayPatternOption](namespace_z_o_s_a_p_i_1_1_tools.xhtml#aa0eba80920a97b8b2b3d256e0fe63201)

Enumerator<a id="aa0eba80920a97b8b2b3d256e0fe63201a540aea6471960421e87985bb9e0922b2" name="aa0eba80920a97b8b2b3d256e0fe63201a540aea6471960421e87985bb9e0922b2"></a>XyFan <a id="aa0eba80920a97b8b2b3d256e0fe63201ad03771938370f42deb52f4c7bca9d2b9" name="aa0eba80920a97b8b2b3d256e0fe63201ad03771938370f42deb52f4c7bca9d2b9"></a>XFan <a id="aa0eba80920a97b8b2b3d256e0fe63201a116b05b870a7644f77e4f64ae6505a39" name="aa0eba80920a97b8b2b3d256e0fe63201a116b05b870a7644f77e4f64ae6505a39"></a>YFan <a id="aa0eba80920a97b8b2b3d256e0fe63201a4ee03e34d9aed688193ce0801e444f51" name="aa0eba80920a97b8b2b3d256e0fe63201a4ee03e34d9aed688193ce0801e444f51"></a>ChiefAndRing <a id="aa0eba80920a97b8b2b3d256e0fe63201a4ee29ca12c7d126654bd0e5275de6135" name="aa0eba80920a97b8b2b3d256e0fe63201a4ee29ca12c7d126654bd0e5275de6135"></a>List <a id="aa0eba80920a97b8b2b3d256e0fe63201a5174d1309f275ba6f275db3af9eb3e18" name="aa0eba80920a97b8b2b3d256e0fe63201a5174d1309f275ba6f275db3af9eb3e18"></a>Grid <a id="aa0eba80920a97b8b2b3d256e0fe63201a2afd4f66b86eaf8d35b93688b7723801" name="aa0eba80920a97b8b2b3d256e0fe63201a2afd4f66b86eaf8d35b93688b7723801"></a>ChiefAndMarginals 



<a id="a3a955211d48653a7f845f495982c2e11" name="a3a955211d48653a7f845f495982c2e11"></a>## [◆ ](#a3a955211d48653a7f845f495982c2e11)RunStatus

 enum [ZOSAPI.Tools.RunStatus](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a3a955211d48653a7f845f495982c2e11)

Enumerator<a id="a3a955211d48653a7f845f495982c2e11a07ca5050e697392c9ed47e6453f1453f" name="a3a955211d48653a7f845f495982c2e11a07ca5050e697392c9ed47e6453f1453f"></a>Completed The tool completed running.

<a id="a3a955211d48653a7f845f495982c2e11a4ace348995a664f8a904bc8263043797" name="a3a955211d48653a7f845f495982c2e11a4ace348995a664f8a904bc8263043797"></a>FailedToStart The tool either failed to start, or a wait was requested on a tool that was not already running.

<a id="a3a955211d48653a7f845f495982c2e11a9541eb2348d883dd8e32ae0420274c4c" name="a3a955211d48653a7f845f495982c2e11a9541eb2348d883dd8e32ae0420274c4c"></a>TimedOut The time out value was exceeded; note that the tool will continue running.

<a id="a3a955211d48653a7f845f495982c2e11ac794d9d363bf315121816d23896ad098" name="a3a955211d48653a7f845f495982c2e11ac794d9d363bf315121816d23896ad098"></a>InvalidTimeout An invalid timeout value was specified.





<a id="a854f4abc9c04e1b2c8fe5fe01b8a8adc" name="a854f4abc9c04e1b2c8fe5fe01b8a8adc"></a>## [◆ ](#a854f4abc9c04e1b2c8fe5fe01b8a8adc)VertexOrder

 enum [ZOSAPI.Tools.VertexOrder](namespace_z_o_s_a_p_i_1_1_tools.xhtml#a854f4abc9c04e1b2c8fe5fe01b8a8adc)

Enumerator<a id="a854f4abc9c04e1b2c8fe5fe01b8a8adca7fb55ed0b7a30342ba6da306428cae04" name="a854f4abc9c04e1b2c8fe5fe01b8a8adca7fb55ed0b7a30342ba6da306428cae04"></a>First <a id="a854f4abc9c04e1b2c8fe5fe01b8a8adcac22cf8376b1893dcfcef0649fe1a7d87" name="a854f4abc9c04e1b2c8fe5fe01b8a8adcac22cf8376b1893dcfcef0649fe1a7d87"></a>Second <a id="a854f4abc9c04e1b2c8fe5fe01b8a8adca168909c0b6f1dfbd48f679d47059c1d6" name="a854f4abc9c04e1b2c8fe5fe01b8a8adca168909c0b6f1dfbd48f679d47059c1d6"></a>Third