Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

FMOPContainer Class Reference

Last update: 16.07.2025

a container storing all Field data models More...

Public Types

typedef std::list< FMOPGroupTFMOPGroupContainer
 a container type for FMOPs
 

Public Member Functions

std::vector< string > elementQuantities ()
 Get ELEMENT_DATA quantities with an existing Field-MOP. More...
 
 eraseElementModel (string quantity, Structure *database)
 deletes the respective random field model (group) More...
 
 eraseNodeModel (string quantity, Structure *database)
 deletes the respective random field model (group) More...
 
 eraseScalarModel (string quantity, Structure *database)
 deletes the respective random field model (group) More...
 
bool exists (string group)
 
FMOPGroup findFMOP (string group)
 
FMOPGroup findFMOP (string quantity, dataobject_types type)
 
FMOPGroup findFMOPRef (string group)
 
FMOPGroup findFMOPRef (string quantity, dataobject_types type)
 
std::vector< string > nodeQuantities ()
 Get NODE_DATA quantities with an existing Field-MOP. More...
 
std::vector< string > scalarQuantities ()
 Get SCALAR_DATA quantities with an existing MOP. More...
 
 writeInternalMOP_OMDBFile (dataobject_types type, string quantity, const ::string path, bool replace_files=true)
 writes the OMDB file of the internal MOP of an FMOP to a file More...
 

Detailed Description

a container storing all Field data models

Member Function Documentation

◆ elementQuantities()

std::vector<string> elementQuantities ( )

Get ELEMENT_DATA quantities with an existing Field-MOP.

Returns
a vector of strings containing all ELEMENT_DATA quantities with an existing Field-MOP

◆ eraseElementModel()

eraseElementModel ( string  quantity,
Structure database 
)

deletes the respective random field model (group)

Parameters
quanitythe field quantity of type ELEMENT_DATA for which the field model is to be deleted
databaseif this pointer is not zero, it is used to invoke listeners informing them that this container was changed
Exceptions
std::Exceptionin case the quantity has no random field model.

◆ eraseNodeModel()

eraseNodeModel ( string  quantity,
Structure database 
)

deletes the respective random field model (group)

Parameters
quanitythe field quantity of type NODE_DATA for which the field model is to be deleted
databaseif this pointer is not zero, it is used to invoke listeners informing them that this container was changed
Exceptions
std::Exceptionin case the quantity has no random field model.

◆ eraseScalarModel()

eraseScalarModel ( string  quantity,
Structure database 
)

deletes the respective random field model (group)

Parameters
quanitythe field quantity of type SCALAR_DATA for which the field model is to be deleted
databaseif this pointer is not zero, it is used to invoke listeners informing them that this container was changed
Exceptions
std::Exceptionin case the quantity has no random field model.

◆ exists()

bool exists ( string  group)
Returns
true if the given group ident is already contained
Parameters
groupthe group ident

◆ findFMOP() [1/2]

FMOPGroup findFMOP ( string  group)
Returns
a reference to the group with given ident
Parameters
groupthe group ident

◆ findFMOP() [2/2]

FMOPGroup findFMOP ( string  quantity,
dataobject_types  type 
)
Returns
a reference to the group to which of the given quantity belongs
Parameters
quantitythe quantity ident
typethe data type of the quantity

◆ findFMOPRef() [1/2]

FMOPGroup findFMOPRef ( string  group)
Returns
a non- reference to the group with given ident
Parameters
groupthe group ident

◆ findFMOPRef() [2/2]

FMOPGroup findFMOPRef ( string  quantity,
dataobject_types  type 
)
Returns
a non- reference to the group to which of the given quantity belongs
Parameters
quantitythe quantity ident

◆ nodeQuantities()

std::vector<string> nodeQuantities ( )

Get NODE_DATA quantities with an existing Field-MOP.

Returns
a vector of strings containing all NODE_DATA quantities with an existing Field-MOP

◆ scalarQuantities()

std::vector<string> scalarQuantities ( )

Get SCALAR_DATA quantities with an existing MOP.

Returns
a vector of strings containing all SCALAR_DATA quantities with an existing MOP

◆ writeInternalMOP_OMDBFile()

writeInternalMOP_OMDBFile ( dataobject_types  type,
string  quantity,
const ::string  path,
bool  replace_files = true 
)

writes the OMDB file of the internal MOP of an FMOP to a file

Parameters
typethe data type , e.g. NODE_DATA
quantitythe quantiytr ident of the field quantity
paththe output file name
replace_filesif false, an error is thrown if the file already exists

Connect with Ansys