Open C API interface to the Scenario product.

Overview:
---------
The Scenario module within NX provides Open API
routines to model an existing geometric model using discrete 3D, 2D,
1D, or 0D finite elements. It also has routines for the application of
loads and boundary conditions on to the geometric model. It has a set
of common functions appropriate to the finite element modeling of
various types of geometric models.

Concepts:
---------
A given geometric model can be meshed with appropriate finite
elements in Scenario. Scenario has a solid mesher that meshes using
tetrahedral elements, a shell mesher that meshes using quadrilateral
or triangular elements, 1D mesher for meshing along curves and a 0D
mesher for generating mass elements.

Loads and boundary conditions are applicable only to the geometry.
They are mapped to the corresponding nodes during analysis.

See the Scenario for FEA User Manual for details on meshing the
model geometry (see the Meshing the Model chapter). For details on
application of loads and boundary conditions, see the Loading the
Model section in the Loads and Boundary Conditions chapter.

Requirements:
------------
As with any user function, you must first call UF_initialize()
before calling any user function defined in this header.

End User Functions equivalent to Scenario dialogs:

Language definition API's:
UF_SFL_ask_cur_language_nx
UF_SFL_ask_num_element_descriptors_nx
UF_SFL_ask_nth_element_descriptor_nx
UF_SFL_ask_element_descriptor_nx
UF_SFL_ask_element_descriptor_name_nx
UF_SFL_ask_num_load_descriptors_nx
UF_SFL_ask_nth_load_descriptor_nx
UF_SFL_ask_load_descriptor_nx
UF_SFL_ask_load_descriptor_name_nx
UF_SFL_ask_num_bc_descriptors_nx
UF_SFL_ask_nth_bc_descriptor_nx
UF_SFL_ask_bc_descriptor_nx
UF_SFL_ask_bc_descriptor_name_nx
UF_SFL_ask_num_solution_descriptors_nx
UF_SFL_ask_nth_solution_descriptor_nx
UF_SFL_ask_solution_descriptor_nx
UF_SFL_set_default_env_nx
UF_SF_ask_language

Solution and Step:
UF_SF_ask_num_solutions_nx
UF_SF_ask_nth_solution_nx
UF_SF_ask_solution_nx
UF_SF_ask_active_solution_nx
UF_SF_ask_active_step_nx
UF_SF_set_active_solution_and_step_nx
UF_SF_solution_ask_descriptor_nx
UF_SF_solution_ask_language_nx
UF_SF_solution_ask_num_steps_nx
UF_SF_solution_ask_nth_step_nx
UF_SF_solution_ask_name_nx
UF_SF_solution_set_name_nx
UF_SF_solution_ask_property_count_nx
UF_SF_solution_ask_property_by_index_nx
UF_SF_solution_ask_property_nx
UF_SF_solution_ask_solver_property_count_nx
UF_SF_solution_ask_solver_property_by_index_nx
UF_SF_solution_ask_solver_property_nx
UF_SF_ask_step_nx
UF_SF_step_ask_name_nx
UF_SF_step_set_name_nx
UF_SF_step_ask_property_count_nx
UF_SF_step_ask_property_by_index_nx
UF_SF_step_ask_property_nx
UF_SF_add_to_solution_nx
UF_SF_add_to_step_nx
UF_SF_remove_from_solution_nx
UF_SF_remove_from_step_nx
UF_SF_locate_solution_loads_nx
UF_SF_locate_solution_boundary_conditions_nx
UF_SF_locate_step_loads_nx
UF_SF_locate_step_boundary_conditions_nx
UF_SF_locate_named_solution_nx
UF_SF_locate_named_step_nx
UF_SF_create_solution_nx
UF_SF_create_step_nx
UF_SF_delete_solution_nx
UF_SF_delete_step_nx

Scenario Meshers:
UF_SF_create_0d_mesh
UF_SF_create_1d_mesh
UF_SF_create_1d_connection_mesh
UF_SF_create_weld_mesh
UF_SF_edit_beam_orientation
UF_SF_create_contact_mesh
UF_SF_create_edge_face_conn
UF_SF_create_ugs_2d_mesh
UF_SF_create_ugs_2d_mesh_with_hdpts
UF_SF_create_ugs_2d_mesh_wt_abstraction_control
UF_SF_get_auto_element_size
UF_SF_create_ugs_tet_mesh
UF_SF_create_ugs_tet_mesh_wt_abstraction_control
UF_SF_create_swept_hex_mesh
UF_SF_ask_ugs_2d_mesh_parms
UF_SF_ask_ugs_tet_mesh_parms
UF_SF_auto_create_mesh_mating_condition
UF_SF_check_model_element_shapes
UF_SF_ask_num_mesh_recipes
UF_SF_ask_nth_mesh_recipe

Section API:
UF_SF_analyse_solid_section
UF_SF_analyse_thin_section
UF_SF_apply_beam_end_mass
UF_SF_apply_offsets
UF_SF_ask_beam_end_mass
UF_SF_ask_mesh_sections
UF_SF_ask_seciton_offsets
UF_SF_ask_section_data
UF_SF_ask_section_prop
UF_SF_create_section
UF_SF_edit_section
UF_SF_free_section_data
UF_SF_link_section
UF_SF_locate_named_section
UF_SF_locate_section
UF_SF_unlink_section

Combined Load cases API:
UF_SF_ask_combined_load_cases
UF_SF_ask_combined_load_case

Material
UF_SF_create_material
UF_SF_link_material
UF_SF_locate_material
UF_SF_locate_named_material
UF_SF_unlink_material
UF_SF_ask_library_materials
UF_SF_ask_material
UF_SF_ask_material_strength
UF_SF_ask_material_formability
UF_SF_ask_material_fatigue
UF_SF_ask_material_type
UF_SF_init_matl_prop
UF_SF_init_formability_prop
UF_SF_init_fatigue_prop
UF_SF_init_matl_strength_prop
UF_SF_free_matl_prop
UF_SF_free_matl_strength_prop
UF_SF_free_formability_prop
UF_SF_free_fatigue_prop
UF_SF_retrieve_library_material

SCENARIO MANAGER API:

UF_SF_create_scenario_nx
UF_SF_locate_scenarios
UF_SF_is_scenario_part
UF_SF_update_scenario

SIMULATION MANAGER API:

UF_SF_create_simulation
UF_SF_simulation_ask_fem
UF_SF_is_simulation

FEM MANAGER API:

UF_SF_create_fem
UF_SF_create_fem_with_geom_opts
UF_SF_is_fem
UF_SF_fem_ask_cad_part

IDEALIZED PART API:

UF_SF_idealized_part_ask_master_part
UF_SF_is_idealized_part

SIMULATION/FEM/IDEALIZED OBJECT MAPPING:

UF_SF_map_object_to_current_part

SFMIDSRF MIDSURFACE API:

UF_SF_create_offset_midsrf
UF_SF_edit_offset_midsrf
UF_SF_is_midsrf
UF_SF_ask_midsrf_frec_type
UF_SF_ask_offset_midsrf_thickness
UF_SF_facepair_ask_midsrf_frec
UF_SF_ask_midsrf_thickness
UF_SF_create_userdef_midsrf
UF_SF_edit_userdef_midsrf
UF_SF_is_userdef_midsrf
UF_SF_free_midsrf_user_parms


IDEALIZE API:
UF_SF_alloc_idealize_parms
UF_SF_free_idealize_parms
UF_SF_ask_idealize_parm_exp
UF_SF_set_idealize_parm_exp
UF_SF_ask_idealize_parm_faces
UF_SF_set_idealize_parm_faces
UF_SF_alloc_idealize_region
UF_SF_free_idealize_region
UF_SF_ask_idealize_region
UF_SF_create_idealize_body
UF_SF_create_idealize_region
UF_SF_ask_idealize_parms
UF_SF_edit_idealize_parms

UF_SF_alloc_defeature_parms
UF_SF_free_defeature_parms
UF_SF_create_defeature_body
UF_SF_edit_defeature_parms

MISCELLANEOUS API:
UF_SF_set_shell_thickness
UF_SF_find_mesh
UF_SF_ask_mesh_visuals
UF_SF_set_mesh_visuals
UF_SF_ask_mesh_dimension
UF_SF_ask_dom_elm_type
UF_SF_ask_geom_data
UF_SF_ask_edge_density
UF_SF_locate_hpt_mg_parents
UF_SF_count_nodes
UF_SF_count_elements
UF_SF_locate_nodes_on_mesh
UF_SF_locate_nodes_on_element
UF_SF_locate_element
UF_SF_locate_element_by_id
UF_SF_locate_node_by_id
UF_SF_ask_node
UF_SF_ask_element
UF_SF_ask_element_edges
UF_SF_ask_node_pgeoms
UF_SF_temp_display_node
UF_SF_temp_display_element
UF_SF_locate_nodes_on_geometry

UF_SF_ask_node_delta
UF_SF_set_nodes_delta_by_id
UF_SF_ask_elem_node_results
UF_SF_set_elem_node_results
UF_SF_free_elem_node_results
UF_SF_get_extreme_values
UF_SF_partition_body
UF_SF_partition_body_nx5
UF_SF_cae_information
UF_SF_reset_element_ids
UF_SF_reset_node_ids

UF_SF_create_hardpoint_on_geom

SOLVER APIs:

UF_SF_solve_active_solution_nx

COMPOSITE OBJECT APIs:
UF_SF_perform_auto_compositing

MESH MATING CONDITION APIs
UF_SF_create_mesh_mating_condition
UF_SF_delete_mesh_mating_condition
UF_SF_edit_mesh_mating_condition
UF_SF_ask_mesh_mating_condition
UF_SF_locate_mesh_mating_condition_list
UF_SF_locate_mesh_mating_condition_by_name

AUTOMATIC FACE PAIR SUBDIVISION APIs
UF_SF_create_auto_face_subdiv

DISPLAY OR TRANSIENT MESH APIs
UF_SF_create_disp_mesh
UF_SF_delete_disp_mesh
UF_SF_display_mesh
UF_SF_free_disp_mesh

LEGEND APIs
UF_SF_LEGEND_create_legend
UF_SF_LEGEND_delete_legend
UF_SF_LEGEND_ask_attribute
UF_SF_LEGEND_new_attr
UF_SF_LEGEND_free_attr
UF_SF_LEGEND_add_index_text_title
UF_SF_LEGEND_add_title_line
UF_SF_LEGEND_format_real_to_str

DURABILITY APIs
UF_SF_locate_named_dursol_nx
UF_SF_ask_num_dursols_nx
UF_SF_ask_nth_dursol_nx
UF_SF_create_dursol_nx
UF_SF_delete_dursol_nx
UF_SF_ask_dursol_nx
UF_SF_edit_dursol_nx
UF_SF_dursol_add_load_nx
UF_SF_dursol_remove_load_nx
UF_SF_dursol_ask_load_count_nx
UF_SF_dursol_ask_load_nx
UF_SF_dursol_locate_all_members_nx
UF_SF_create_lv_nx
UF_SF_delete_lv_nx
UF_SF_ask_lv_nx
UF_SF_edit_lv_nx

PROPERTY APIs
UF_SF_property_ask_name_nx
UF_SF_property_ask_type_nx
UF_SF_property_set_value_nx
UF_SF_property_ask_value_nx

LANGUAGE SOLUTION APIs
UF_SFL_solution_descriptor_ask_name_nx
UF_SFL_solution_descriptor_ask_num_allowable_step_descriptors_nx
UF_SFL_solution_descriptor_ask_nth_allowable_step_descriptor_nx
UF_SFL_solution_ask_lbc_desc_valid_nx

LANGUAGE STEP APIs
UF_SFL_step_descriptor_ask_name_nx
UF_SFL_step_ask_lbc_desc_valid_nx

LANGUAGE SOLVER APIs
UF_SFL_ask_num_solvers_nx
UF_SFL_ask_nth_solver_nx
UF_SFL_ask_solver_nx
UF_SFL_ask_num_languages_nx
UF_SFL_ask_nth_language_nx
UF_SFL_ask_language_nx

FEM GEOMETRIC ACCESS APIs

UF_SF_polygon_body_ask_type
UF_SF_ask_all_polygon_bodies
UF_SF_body_ask_edges
UF_SF_body_ask_faces
UF_SF_body_ask_bounding_box
UF_SF_body_ask_modl_body
UF_SF_modl_body_ask_body
UF_SF_face_ask_edges
UF_SF_face_ask_body
UF_SF_face_ask_area
UF_SF_face_ask_bounding_box
UF_SF_face_ask_adjacent_faces
UF_SF_ask_adjacent_faces
UF_SF_edge_ask_faces
UF_SF_edge_ask_body
UF_SF_edge_ask_length
UF_SF_edge_ask_bounding_box
UF_SF_edge_ask_adjacent_edges
UF_SF_edge_ask_end_points
UF_SF_find_minimum_distance
UF_SF_ask_closest_point

Internal type definitions for UF_SF_COMPOSITE (Scenario Composite Face)
module.

Internal type definitions for UF_SF_DISP_MESH (Scenario Display Mesh) module.

This file contains User functions for Model Checker's - element check.

List of User functions:

1. UF_SF_mc_aspect_ratio
2. UF_SF_mc_warp
3. UF_SF_mc_skew
4. UF_SF_mc_taper
5. UF_SF_mc_twist
6. UF_SF_mc_jacobian_ratio
7. UF_SF_mc_jacobian_zero
8. UF_SF_mc_tetra_angle
9. UF_SF_mc_2d_angle
10. UF_SF_mc_element_check
11. UF_SF_mc_tet_collapse

Language Definitions for the Scenario User Function module.

Internal type definitions for UF_SF_LEGEND (Scenario Legend) module.

The LEGEND module uses an attribute structure in order to define what
is displayed in the legend. The attribute structure should be built
by the application using the functions provided in the LEGEND API. The
functions assist in allocating and freeing the attribute structure and
in adding text strings in order to display. Assigning simple values to
the attribute structure is left to the application.

It is not necessary for applications to define each and every attribute
for the legend if the default is what is wanted. This is the reason for
attribute masks for each structure in the attribute structure.
Application code sets the desired attributes to define and then sets the
corresponding value in the attribute structure. For adding text strings,
convenience functions are provided.

The best way to learn how to use this API is some example code which is
provided below. The examples both show the use of the LEGEND API as
well as the CGP_PART API since the latter is an integral part of
display scalar fringes and such.

This is the Open C interface to the scenario model checker.

Internal type definitions for UF_SF_MSHVLD (Scenario Mesh Validation)
module.

文件描述:

Datatypes for the UF_SF (Scenario User Function ) Post Processor module.

Data Definitions for the Open C API interface to Scenario.

Open C API interface to the Scenario product.

Overview:
---------
The Scenario module within NX provides Open API
routines to model an existing geometric model using discrete 3D, 2D,
1D, or 0D finite elements. It also has routines for the application of
loads and boundary conditions on to the geometric model. It has a set
of common functions appropriate to the finite element modeling of
various types of geometric models.

Concepts:
---------
A given geometric model can be meshed with appropriate finite
elements in Scenario. Scenario has a solid mesher that meshes using
tetrahedral elements, a shell mesher that meshes using quadrilateral
or triangular elements, 1D mesher for meshing along curves and a 0D
mesher for generating mass elements.

Loads and boundary conditions are applicable only to the geometry.
They are mapped to the corresponding nodes during analysis.

See the Scenario for FEA User Manual for details on meshing the
model geometry (see the Meshing the Model chapter). For details on
application of loads and boundary conditions, see the Loading the
Model section in the Loads and Boundary Conditions chapter.

End User Functions equivalent to Scenario dialogs:

Language definition API's:
UF_SF_ask_anl_langs
UF_SF_ask_language
UF_SF_locate_anl_lang
UF_SF_set_cur_anl_lang

Scenario Meshers:
UF_SF_create_0d_mesh
UF_SF_create_1d_mesh
UF_SF_create_weld_mesh
UF_SF_edit_beam_orientation
UF_SF_create_2d_mesh
UF_SF_create_contact_mesh

Scenario Constraints:
UF_SF_create_load
UF_SF_ask_load
UF_SF_edit_load
UF_SF_locate_load
UF_SF_locate_load_geom
UF_SF_create_load_case
UF_SF_create_bc
UF_SF_ask_bc
UF_SF_edit_bc
UF_SF_locate_bc
UF_SF_locate_bc_geom

Section API:
UF_SF_apply_offsets
UF_SF_ask_seciton_offsets
UF_SF_ask_section_prop
UF_SF_locate_section
UF_SF_ask_mesh_sections
UF_SF_ask_section_data
UF_SF_free_section_data
UF_SF_link_section
UF_SF_unlink_section
UF_SF_edit_section
UF_SF_create_section
UF_SF_locate_named_section
UF_SF_apply_beam_end_mass
UF_SF_ask_beam_end_mass

Load cases API:
UF_SF_create_load_case
UF_SF_locate_all_lbc_cases
UF_SF_add_to_lbc_case
UF_SF_remove_from_lbc_case
UF_SF_locate_lbc_members
UF_SF_ask_lbc_name
UF_SF_ask_lbc_case
UF_SF_copy_lbc_to_case
UF_SF_locate_named_lbc_case

Combined Load cases API:
UF_SF_ask_combined_load_cases
UF_SF_ask_combined_load_case
UF_SF_create_combined_load_case

Material
UF_SF_create_material
UF_SF_link_material
UF_SF_locate_material
UF_SF_locate_named_material
UF_SF_unlink_material
UF_SF_ask_material
UF_SF_ask_material_type
UF_SF_init_matl_prop
UF_SF_free_matl_prop

SCENARIO MANAGER API:

UF_SF_create_scenario
UF_SF_locate_scenarios
UF_SF_is_scenario_part

SFMIDSRF MIDSURFACE API:

UF_SF_create_offset_midsrf
UF_SF_edit_offset_midsrf
UF_SF_is_midsrf
UF_SF_ask_midsrf_thickness

MISCELLANEOUS API:
UF_SF_set_shell_thickness
UF_SF_find_mesh
UF_SF_ask_mesh_visuals
UF_SF_set_mesh_visuals
UF_SF_ask_mesh_dimension
UF_SF_ask_dom_elm_type
UF_SF_ask_geom_data
UF_SF_ask_edge_density
UF_SF_locate_hpt_mg_parents
UF_SF_count_nodes
UF_SF_count_elements
UF_SF_locate_nodes_on_mesh
UF_SF_locate_nodes_on_element
UF_SF_locate_element
UF_SF_locate_element_by_id
UF_SF_locate_node_by_id
UF_SF_ask_node
UF_SF_ask_element
UF_SF_ask_element_edges
UF_SF_ask_node_pgeoms
UF_SF_temp_display_node
UF_SF_temp_display_element
UF_SF_locate_nodes_on_geometry
UF_SF_temp_disp_results
UF_SF_delete_disp_results
UF_SF_LEGEND_set_colors

SOLVER APIs:

UF_SF_analysis_nastran
UF_SF_analysis_ansys

Internal type definitions for UF_SF_UGS_MESH (Scenario UGS Mesher)
module.