FluidDomainRecipe Class

class NXOpen.CAE.FluidDomainRecipe

Bases: NXOpen.NXObject

Represents a FluidDomainRecipe

To create or edit an instance of this class, use NXOpen.CAE.FluidDomainBuilder

New in version NX8.0.0.

Properties

Property	Description
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.

Methods

Method	Description
AddAutoRefinementConstraint	Adds a NXOpen.CAE.CfdAutoRefinementConstraint constraint
AddContactPreventionConstraint	Adds a NXOpen.CAE.CfdContactPreventionConstraint constraint
AddLocalResolutionConstraint	Adds a NXOpen.CAE.CfdLocalResolutionConstraint constraint
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetFluidBodies	Get the list of fluid bodies associated with the fluid domain recipe
GetFluidBody	Gets the first fluid body associated with the fluid domain recipe
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetName	Gets the name of the fluid domain recipe
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	Prints a representation of this object to the system log file.
RemoveAutoRefinementConstraint	Removes a NXOpen.CAE.CfdAutoRefinementConstraint constraint
RemoveContactPreventionConstraint	Removes a NXOpen.CAE.CfdContactPreventionConstraint constraint
RemoveLocalResolutionConstraint	Removes a NXOpen.CAE.CfdLocalResolutionConstraint constraint
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetName	Sets the name of the fluid domain recipe
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
SyncFaceNamesAndAttributes	Synchronize the fluid body face names and attributes with the faces of the source polygonal bodies

Property Detail

IsOccurrence

FluidDomainRecipe.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

FluidDomainRecipe.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

FluidDomainRecipe.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

FluidDomainRecipe.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

FluidDomainRecipe.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

FluidDomainRecipe.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

AddAutoRefinementConstraint

FluidDomainRecipe.AddAutoRefinementConstraint

Adds a NXOpen.CAE.CfdAutoRefinementConstraint constraint

Signature AddAutoRefinementConstraint(autoRefinementConstraint)

Parameters:autoRefinementConstraint (NXOpen.CAE.CfdAutoRefinementConstraint) – The constraint to be added to the recipe

New in version NX11.0.0.

License requirements: nx_adv_fld_mod_solv (“NX Advanced Fluid Modeling - Full”) OR sc_acou_meshing (” SC Acoustic Meshing”)

AddContactPreventionConstraint

FluidDomainRecipe.AddContactPreventionConstraint

Adds a NXOpen.CAE.CfdContactPreventionConstraint constraint

Signature AddContactPreventionConstraint(contactPreventionConstraint)

Parameters:contactPreventionConstraint (NXOpen.CAE.CfdContactPreventionConstraint) –

New in version NX9.0.0.

License requirements: nx_adv_fld_mod_solv (“NX Advanced Fluid Modeling - Full”) OR sc_acou_meshing (” SC Acoustic Meshing”)

AddLocalResolutionConstraint

FluidDomainRecipe.AddLocalResolutionConstraint

Adds a NXOpen.CAE.CfdLocalResolutionConstraint constraint

Signature AddLocalResolutionConstraint(localResolutionConstraint)

Parameters:localResolutionConstraint (NXOpen.CAE.CfdLocalResolutionConstraint) –

New in version NX9.0.0.

License requirements: nx_adv_fld_mod_solv (“NX Advanced Fluid Modeling - Full”) OR sc_acou_meshing (” SC Acoustic Meshing”)

FindObject

FluidDomainRecipe.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetFluidBodies

FluidDomainRecipe.GetFluidBodies

Get the list of fluid bodies associated with the fluid domain recipe

Signature GetFluidBodies()

Returns: Return type:list of NXOpen.CAE.CAEBody

New in version NX12.0.0.

License requirements: None.

GetFluidBody

FluidDomainRecipe.GetFluidBody

Gets the first fluid body associated with the fluid domain recipe

Signature GetFluidBody()

Returns: Return type:NXOpen.CAE.CAEBody

New in version NX11.0.0.

License requirements: None.

GetName

FluidDomainRecipe.GetName

Gets the name of the fluid domain recipe

Signature GetName()

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

Print

FluidDomainRecipe.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveAutoRefinementConstraint

FluidDomainRecipe.RemoveAutoRefinementConstraint

Removes a NXOpen.CAE.CfdAutoRefinementConstraint constraint

Signature RemoveAutoRefinementConstraint(autoRefinementConstraint)

Parameters:autoRefinementConstraint (NXOpen.CAE.CfdAutoRefinementConstraint) – The constraint to be removed from the recipe

New in version NX11.0.0.

License requirements: nx_adv_fld_mod_solv (“NX Advanced Fluid Modeling - Full”) OR sc_acou_meshing (” SC Acoustic Meshing”)

RemoveContactPreventionConstraint

FluidDomainRecipe.RemoveContactPreventionConstraint

Removes a NXOpen.CAE.CfdContactPreventionConstraint constraint

Signature RemoveContactPreventionConstraint(contactPreventionConstraint)

Parameters:contactPreventionConstraint (NXOpen.CAE.CfdContactPreventionConstraint) –

New in version NX9.0.0.

License requirements: nx_adv_fld_mod_solv (“NX Advanced Fluid Modeling - Full”) OR sc_acou_meshing (” SC Acoustic Meshing”)

RemoveLocalResolutionConstraint

FluidDomainRecipe.RemoveLocalResolutionConstraint

Removes a NXOpen.CAE.CfdLocalResolutionConstraint constraint

Signature RemoveLocalResolutionConstraint(localResolutionConstraint)

Parameters:localResolutionConstraint (NXOpen.CAE.CfdLocalResolutionConstraint) –

New in version NX9.0.0.

License requirements: nx_adv_fld_mod_solv (“NX Advanced Fluid Modeling - Full”) OR sc_acou_meshing (” SC Acoustic Meshing”)

SetName

FluidDomainRecipe.SetName

Sets the name of the fluid domain recipe

Signature SetName(name)

Parameters:name (str) –

New in version NX8.0.0.

License requirements: nx_adv_fluid_mod (“NX Advanced Fluid Modeling - Basic”) OR sc_acou_meshing (” SC Acoustic Meshing”)

SyncFaceNamesAndAttributes

FluidDomainRecipe.SyncFaceNamesAndAttributes

Synchronize the fluid body face names and attributes with the faces of the source polygonal bodies

Signature SyncFaceNamesAndAttributes()

New in version NX11.0.2.

License requirements: nx_adv_fluid_mod (“NX Advanced Fluid Modeling - Basic”) OR sc_acou_meshing (” SC Acoustic Meshing”)