NX Open for CAE documentation resources

There are two key documentation resources that you will need to use when you create applications with NX Open for CAE:

• The NX Open API documentation.

• The NX Open for CAE documentation.

Both of these resources can be found in the Programming Tools documentation within the Help.

NX Open API documentation

The general NX Open API documentation provides information on all classes for each of the major programming languages (for example, .NET, Java, C++, Python).

For example, within the Help, Programming Tools→NX Open→Open for .NET→NX Open for .NET Reference Guide provides a complete API reference for NX Open for .NET in Microsoft Compiled Help (.chm) format.

Note:

The CAE classes are found in the NXOpen.CAE namespace.

The documentation for each class includes:

• A short description of the class.

• A list of the members of that class, including the available properties and methods.

• Remarks, which can contain information on how to create an instance of the class.

• An instance hierarchy, which displays the predecessors that the class inherits from. This is useful for finding the interface classes, which are common in the CAE data model.For example, notice how the MeshManager and MeshManagerOccurrence classes share the same interface class:

NX Open for CAE documentation

The NX Open for CAE documentation supplements the general NX Open API documentation. It includes documentation for the CAE Solver Environment (solver languages) and on the meshing technologies supported by the CAE applications.

You can find it in the Help at Programming Tools→NX Open→Open for CAE.

In the Solver Environment section, for each supported solver, the documentation lists all supported entities and includes:

• The language-specific name and the name that appears in the user interface. Sometimes these names are the same, and sometimes they are different. Additionally, the name you need to provide in NX Open for CAE applications is not consistent. Therefore, the name required by NX Open for CAE is shown in red.

• A link to sample JA code, which demonstrates correct coding for each entity.

The following graphic shows an example of the documentation for the Simcenter Nastran CBEAM element. In this case, CBEAM is both the name that appears in the user interface and the name you need to provide to NX Open.

Using the NX Open API and NX Open documentation together

When you create NX Open for CAE applications, you will need to use both of these documentation resources. For example, suppose you wanted to create an application that would generate a mesh of 2D elements. You would:

• Consult the NX Open API documentation for information on how to use the NXOpen::CAE::ElementCreateBuilder class.

• Consult NX Open for CAE for information on the supported element types for a given solver.

Additional programming documentation resources

The Help provides complete documentation for tools that you can use to customize the software and to automate its workflows. You may find these additional topics useful:

• Programming Tools→NX Open→NX Open Programmer's Guide introduces the information that you might need when developing automation solutions using the NX Open toolkits.

• Programming Tools→Block UI Styler provides complete information for the Block UI Styler application, which you can use to interactively build dialog boxes that are consistent with the software's block-based user interface.

• Fundamentals→Customizing the NX environment→Customizing your environment→Customizing Ribbon bar, toolbars, and menus provides information about adding applications to the navigation system.

• There are several examples of Visual Basic programs which use NX Open to perform Pre/Post operations. These examples are located on the product installation disc in this folder: %UGII_BASE_DIR%\ugopen\SampleNxOpenApplications.NET\CAE.

Learn more

NX Open for CAE terminology and concepts

CAD terminology and concepts

CAE terminology and concepts

The importance of the work part in CAE applications

Overview of the CAE data model

Working with objects in the CAE data model

Overview of the CAE solver languages

Working with the CAE solver languages: name strings

Working with the CAE solver languages: property tables

Creating undo marks and forcing model updates

Look up more details

NX Open for CAE code examples

Quick links

Command reference

Pre/Post video examples

Bulk Entry Descriptions

Simcenter 3D tutorials

Browse Simcenter 3D help by product area

NX Open for CAE documentation resources, Simcenter 3D 2021.1 Series

© 2020 Siemens

window.mainLanguage="en_US"

window.delivId=""

window.projectId=""

MathJax.Hub.Config({ TeX: { extensions: ["autoload-all.js"] }, tex2jax: { displayMath: [ ] }, "SVG": { scale: 125 } });