Checks and Corrections

Custom checks and corrections come in two types:

• Common checks/corrections - Those which use a common function underneath and can be added across multiple entity types, or across multiple solvers.
• Solver checks/corrections - Those that are unique to a specific solver.

Tcl procedures are used to define the behavior of checks and corrections. These Tcl procedures must exist in pre-defined namespaces:

• ::HM::ModelCheck::HyperMesh for common procedures.
• ::HM::ModelCheck::LsDyna for LS-DYNA specific procedures.
• ::HM::ModelCheck::Nastran for Nastran specific procedures.
• ::HM::ModelCheck::OptiStruct for OptiStruct specific procedures.
• ::HM::ModelCheck::RadiossBlock for RADIOSS specific procedures.

In the installation, there are several locations where example procedures are located:

Common custom check/correction procedures

<altair_home>/hm/scripts/ModelCheck/HyperMesh/modelcheckmain.tcl - Sources the files that define the common custom checks/corrections.

<altair_home>/hm/scripts/ModelCheck/HyperMesh/entitychecks.tcl - Contains the common custom checks/corrections.

Solver custom check/correction procedures

<altair_home>/hm/scripts/ModelCheck/<solver>/Checks_Corrections/modelcheckmain.tcl - Sources the files that define the <solver> custom checks/corrections.

<altair_home>/hm/scripts/ModelCheck/<solver>/Checks_Corrections/entitychecks.tcl - Contains the <solver> custom checks/corrections.

Here is an example of a custom check and correction definition for both a common check and an LS-DYNA check:

/MODCHK/SOLVER/LSDYNA
#=======================================
/MODCHK/GROUP
Property Cards
#---------------------------------------
/MODCHK/CHECK/WARNING/HM::ModelCheck::HyperMesh::UnusedEntities/Props
Unused properties
Unused
/MODCHK/CORRECTION/HM::ModelCheck::HyperMesh::DeleteUnusedEntities
Delete unused properties
#---------------------------------------
/MODCHK/CHECK/ERROR/HM::ModelCheck::LsDyna::CheckTSandTTequalities/Props
Check TS and TT equalities
TsTTChecks
/MODCHK/CORRECTION/ModifyManually
Modify Manually
/MODCHK/CORRECTIONMODE/props/ / /
#---------------------------------------

A custom path can be defined using the following syntax.

/MODCHK/CHECK/TCLPath/{<PATH>}

or

/MODCHK/CORRECTION/TCLPath/{<PATH>}

Using the example above, you might define your own common procedures in a file named C:/my_common_checks.tcl and LS-DYNA procedures in C:/my_dyna_checks.tcl.

/MODCHK/SOLVER/LSDYNA
#=======================================
/MODCHK/GROUP
Property Cards
#---------------------------------------
/MODCHK/CHECK/TCLPath/{C:/my_common_checks.tcl}
/MODCHK/CHECK/WARNING/HM::ModelCheck::HyperMesh::UnusedEntities/Props
Unused properties
Unused
/MODCHK/CORRECTION/TCLPath/{C:/my_common_checks.tcl}
/MODCHK/CORRECTION/HM::ModelCheck::HyperMesh::DeleteUnusedEntities
Delete unused properties
#---------------------------------------
/MODCHK/CHECK/TCLPath/{C:/my_dyna_checks.tcl}
/MODCHK/CHECK/ERROR/HM::ModelCheck::LsDyna::CheckTSandTTequalities/Props
Check TS and TT equalities
TsTTChecks
/MODCHK/CORRECTION/ModifyManually
Modify Manually
/MODCHK/CORRECTIONMODE/props/ / /
#---------------------------------------

There are a few points to keep in mind about custom definitions:

• The Tcl file name should be unique.
• The Tcl check and correction function names should be unique.
• The check display name and correction display name should be unique.

Continuing with the above example, the generic UnusedEntities check and corresponding DeleteUnusedEntities correction might look something like this:

namespace eval :::HM::ModelCheck::HyperMesh {}

proc ::HM::ModelCheck::HyperMesh::UnusedEntities { checkDisplayname } {
#Get the entity type for the check
set entitytype [hm_getmodelcheckenttype $checkDisplayname];

#Find the unused entities of the required type
*EntityPreviewUnused $entitytype 1;

#Set the unused entities found by the check
hm_setmodelcheckresultentids $checkDisplayname 1;

#Set the check status to "run"
hm_setmodelcheckcheckstatus $checkDisplayname 1;
}

proc ::HM::ModelCheck::HyperMesh::DeleteUnusedEntities { checkDisplayname flag mark } {
#Get the entity type for the correction
set entitytype [hm_getmodelcheckenttype $checkDisplayname];

#Get the unused entities found by the check
set resultentids [hm_getmodelcheckresultentids $checkDisplayname];

#Delete the unused entities
hm_createmark $entitytype 1 "by id only" $resultentids;
catch {*deletemark $entitytype 1};

#Set the correction status to "applied"
set correctionDisplayname [hm_getmodelcheckcorrectiondisplayname $checkDisplayname];
hm_setmodelcheckcorrectionstatus $checkDisplayname $correctionDisplayname 1; 
}

There are a few points to keep in mind about custom procedures:

• You must define the namespace inside of your custom Tcl script. For example: namespace eval ::HM::ModelCheck::LsDyna {}
• The check display name is passed in as an argument to both the check and correction procedures and must be handled accordingly.
• The flag and mark arguments are passed to the correction procedure and must be handled accordingly. The flag will be 0 and the mark will be NULL if the correction should be applied to all entities. Otherwise, flag will be non-zero and the mark will be the ID of the mark containing the entities to which the correction should be applied.
• The check and correction procedures can include any simple or advanced logic that is necessary.
• There are several Model Check APIs that are necessary for creating custom checks/corrections, as used in the example above:
  • hm_getmodelcheckenttype
  • hm_getmodelcheckresultentids
  • hm_setmodelcheckresultentids
  • hm_setmodelcheckcheckstatus
  • hm_setmodelcheckcorrectionstatus