All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisExplicitElement

CATAnalysisBase.CATAnalysisExplicitData
  |
  +---CATAnalysisBase.CATAnalysisExplicitChild
    |
    +---CATAnalysisBase.CATAnalysisExplicitParent
      |
      +---CATAnalysisBase.CATAnalysisExplicitEntity
        |
        +---CATAnalysisExplicitElement
 

Usage: you must use this class as is. You should never derive it.


public class CATAnalysisExplicitElement

Field model element.
This object is used to provide services common to objects of the field model which can represent the Meshing Elements and their physical behavior.


Constructor and Destructor Index


o CATAnalysisExplicitElement()
Default constructor.
o CATAnalysisExplicitElement(CATAnalysisExplicitData&)
Copy constructor.
o CATAnalysisExplicitElement(CATAnalysisExplicitElement&)
Copy constructor.

Method Index


o CanEvaluateLocalAxis(CATBoolean&)
Returns if a local axis can be evaluated.
o CreateElement(CATAnalysisExplicitSet&,CATMSHElement*,CATSamPhysicalType)
Create the field model representation of a mesh element.
o GetAttachedLocalAxis(CATString&,int,CATBoolean&,CATMathVector&,CATMathVector&,CATMathVector&)
Returns the definition of the local axis.
o GetAttachedLocalAxis(int&,CATAnalysisExplicitAxis*(&))
Returns the CATAnalysisExplicitAxis attached to.
o GetConnectivity(CATIMSHConnectivity*(&))
Returns the mesh connectivity.
o GetGeometricalEngine(CATMSHGeometricalEngine*(&))
Returns the GeometricalEngine.
o GetImplicitLocalAxis(CATString&,int,CATBoolean&,CATMathVector&,CATMathVector&,CATMathVector&)
Returns the definition of the implicit axis.
o GetLinkedNodes(CATSamExplicitPtr*(&))
Returns the linked Nodes to the Element.
o GetLocalAxis(CATString&,int,CATBoolean&,CATMathVector&,CATMathVector&,CATMathVector&)
Returns the definition of the local axis.
o GetMeshPointer(void)
Returns the pointer of the mesh Element object.
o GetMeshTag(unsigned int&)
Returns the tag (ie unique identifier) of the mesh element object.
o GetNumberOfAvailablePosition(CATString&,int&)
Returns the number of available position.
o GetNumberOfLinkedNodes(int&)
Returns the number of linked Nodes.
o GetNumberOfPrincipalLinkedNodes(int&)
Returns the number of principal linked Nodes.
o GetPositionCoordinates(CATString&,int,CATBoolean&,double[3])
Returns intrinsic coordinates according to a position identifier, and a position number.
o GetPositionCoordinates(CATString&,int,CATBoolean&,float[3])
Returns intrinsic coordinates according to a position identifier, and a position number.
o GetPositionCoordinates(float[3],CATBoolean&,double[3])
Returns internal coordinates according to parametric parameter.
o GetPositionCoordinates(float[3],CATBoolean&,float[3])
Returns internal coordinates according to parametric parameter.
o HaveAttachedLocalAxis(CATBoolean&)
Returns if a local axis is attached.
o LinkWithMeshPointer(CATMSHElement*,CATAnalysisExplicitModel*)
Retrieves the link to the current object with a field model Element based on a mesh pointer.
o LinkWithMeshTag(unsigned int,CATAnalysisExplicitModel*)
Links the current object with a field model element based on a mesh element tag.
o LinkWithPointer(CATSamExplicitPtr,CATAnalysisExplicitModel*)
Links the current object with a field model element based on its pointer.
o SetMeshPointer(CATMSHElement*)
Creates the link to the current unlinked explicit element with an element mesh pointer.
o operator =(CATAnalysisExplicitData&)
Assignment operator.
o operator =(CATAnalysisExplicitElement&)
Assignment operator.

Constructor and Destructor


o CATAnalysisExplicitElement
public CATAnalysisExplicitElement()
Default constructor.
o CATAnalysisExplicitElement
public CATAnalysisExplicitElement( const CATAnalysisExplicitData& iData)
Copy constructor.
o CATAnalysisExplicitElement
public CATAnalysisExplicitElement( const CATAnalysisExplicitElement& iElement)
Copy constructor.

Methods


o CanEvaluateLocalAxis
public HRESULT CanEvaluateLocalAxis(CATBoolean& oIsValid) const
Returns if a local axis can be evaluated.
Parameters:
oIsValid

Legal values:
  • TRUE if a local axis is valid.
  • FALSE if a local axis can not be computed.
o CreateElement
public HRESULT CreateElement(CATAnalysisExplicitSet& iElementSet,
CATMSHElement* iMeshElement,
CATSamPhysicalType iElementPhysicalType)
Create the field model representation of a mesh element.
Parameters:
iElementSet
The parent element set.
iMeshElement
The mesh Element pointer.
iElementPhysicalType
The physical type of the element.
o GetAttachedLocalAxis
public HRESULT GetAttachedLocalAxis( const CATString& iPosition,
int iPositionNumber,
CATBoolean& isAttached,
CATMathVector& oVecU,
CATMathVector& oVecV,
CATMathVector& oVecW) const
Returns the definition of the local axis. In case of the local axis can not be computed, the method return the Global Axis.
Parameters:
iPosition
The position identifier.
iPositionNumber
The position number.
isAttached
Returns TRUE if a local axis is attached..
oVecU
The U Vector of the local axis.
oVecV
The V Vector of the local axis.
oVecW
The W Vector of the local axis.
o GetAttachedLocalAxis
public HRESULT GetAttachedLocalAxis(int& oNbLocalAxis,
CATAnalysisExplicitAxis*(&) oAxis) const
Returns the CATAnalysisExplicitAxis attached to.
Parameters:
oNbLocalAxis
The number of attached CATAnalysisExplicitAxis. It can be either 1, the CATAnalysisExplicitAxis is defined for the whole CATAnalysisExplicitElement, either N, the N CATAnalysisExplicitAxis are defined for each of the N node of the CATAnalysisExplicitElement.
oAxis
The CATAnalysisExplicitAxis.
See also:
CATAnalysisExplicitAxis
o GetConnectivity
public HRESULT GetConnectivity(CATIMSHConnectivity*(&) oMshConnectivity) const
Returns the mesh connectivity.
Parameters:
oMshConnectivity
The Connectivity.
Lifecycle rules deviation: No AddRef is done on returned value.
o GetGeometricalEngine
public HRESULT GetGeometricalEngine(CATMSHGeometricalEngine*(&) oMshGeometricalEngine) const
Returns the GeometricalEngine.
Parameters:
oMshGeometricalEngine
The GeometricalEngine.
o GetImplicitLocalAxis
public HRESULT GetImplicitLocalAxis( const CATString& iPosition,
int iPositionNumber,
CATBoolean& isEvaluated,
CATMathVector& oVecU,
CATMathVector& oVecV,
CATMathVector& oVecW) const
Returns the definition of the implicit axis. according to a position identifier, and a position number.
In case of the implicit axis can not be computed, the method return the Global Axis.
Parameters:
iPosition
The position identifier.
iPositionNumber
The position number.
isEvaluated
Returns TRUE if a implicit axis can be evaluated.
oVecU
The U Vector of the implicit local axis.
oVecV
The V Vector of the implicit local axis.
oVecW
The W Vector of the implicit local axis.
o GetLinkedNodes
public HRESULT GetLinkedNodes(CATSamExplicitPtr*(&) oLinkedNodes) const
Returns the linked Nodes to the Element.
Parameters:
oLinkedNodes
The linked Nodes.
This parameter must be equal to NULL when this method is called.
The memory for the array is allocated by this method but must be de-allocated by the caller.
See also:
CATAnalysisExplicitNode
o GetLocalAxis
public HRESULT GetLocalAxis( const CATString& iPosition,
int iPositionNumber,
CATBoolean& isEvaluated,
CATMathVector& oVecU,
CATMathVector& oVecV,
CATMathVector& oVecW) const
Returns the definition of the local axis. This is done according to a position identifier, and a position number.
In case of the current instance have a local axis attached the definition of this local axis will be returned, else if an implicit axis can be computed the definition of this implicit axis will be returned, otherwise the method return the Global Axis.
Parameters:
iPosition
The position identifier.
iPositionNumber
The position number.
isEvaluated
Returns TRUE if a local or an implicit can be evaluated.
oVecU
The U Vector.
oVecV
The V Vector.
oVecW
The W Vector..
o GetMeshPointer
public CATMSHElement * GetMeshPointer(void ) const
Returns the pointer of the mesh Element object.
Returns:
the mesh pointer.
o GetMeshTag
public HRESULT GetMeshTag(unsigned int& oMeshTag) const
Returns the tag (ie unique identifier) of the mesh element object.
Parameters:
oMeshTag
The mesh Element tag.
o GetNumberOfAvailablePosition
public HRESULT GetNumberOfAvailablePosition( const CATString& iPosition,
int& oNumber) const
Returns the number of available position. They are defined according to a position identifier.
Parameters:
iPosition
The position identifier.
oNumber
The number of available position.
o GetNumberOfLinkedNodes
public HRESULT GetNumberOfLinkedNodes(int& oNumber) const
Returns the number of linked Nodes.
Parameters:
oNumber
The number of linked Nodes.
o GetNumberOfPrincipalLinkedNodes
public HRESULT GetNumberOfPrincipalLinkedNodes(int& oNumber) const
Returns the number of principal linked Nodes.
Parameters:
oNumber
The number of principal linked Nodes.
o GetPositionCoordinates
public HRESULT GetPositionCoordinates( const CATString& iPosition,
int iPositionNumber,
CATBoolean& isValid,
double[3] oCoordinates) const
Returns intrinsic coordinates according to a position identifier, and a position number. In case of the position is invalid, the method return the origin coordinates.
Parameters:
iPosition
The position identifier.
iPositionNumber
The position number.
isValid
Returns TRUE if the position is valid.
oCoordinates
The coordinates of the computed position.
o GetPositionCoordinates
public HRESULT GetPositionCoordinates( const CATString& iPosition,
int iPositionNumber,
CATBoolean& isValid,
float[3] oCoordinates) const
Returns intrinsic coordinates according to a position identifier, and a position number. In case of the position is invalid, the method return the origin coordinates.
Parameters:
iPosition
The position identifier.
iPositionNumber
The position number.
isValid
Returns TRUE if the position is valid.
oCoordinates
The coordinates of the computed position.
o GetPositionCoordinates
public HRESULT GetPositionCoordinates( const float[3] iUVW,
CATBoolean& isValid,
double[3] oCoordinates) const
Returns internal coordinates according to parametric parameter. In case of the position is invalid, the method return the origin coordinates.
Parameters:
iUVW
The UVW parameters.
isValid
Returns TRUE if the position is valid.
oCoordinates
The coordinates of the computed position.
o GetPositionCoordinates
public HRESULT GetPositionCoordinates( const float[3] iUVW,
CATBoolean& isValid,
float[3] oCoordinates) const
Returns internal coordinates according to parametric parameter. In case of the position is invalid, the method return the origin coordinates.
Parameters:
iUVW
The UVW parameters.
isValid
Returns TRUE if the position is valid..
oCoordinates
The coordinates of the computed position.
o HaveAttachedLocalAxis
public HRESULT HaveAttachedLocalAxis(CATBoolean& oHadLocalAxis) const
Returns if a local axis is attached.
Parameters:
oHadLocalAxis
  • TRUE if a local axis is defined.
  • FALSE if no local axis is defined.
o LinkWithMeshPointer
public HRESULT LinkWithMeshPointer(CATMSHElement* iMeshPointer,
const CATAnalysisExplicitModel* iModel)
Retrieves the link to the current object with a field model Element based on a mesh pointer.
Parameters:
iMeshPointer
The pointer of the mesh Element.
iModel
A pointer to the field model.
o LinkWithMeshTag
public HRESULT LinkWithMeshTag(unsigned int iMeshTag,
const CATAnalysisExplicitModel* iModel)
Links the current object with a field model element based on a mesh element tag.
Parameters:
iMeshTag
The tag of the mesh Element.
iModel
A pointer to the field model.
o LinkWithPointer
public HRESULT LinkWithPointer(CATSamExplicitPtr iExplicitPtr,
const CATAnalysisExplicitModel* iModel)
Links the current object with a field model element based on its pointer.
Parameters:
iExplicitPtr
The pointer to the field model object.
iModel
A pointer to the field model.
o SetMeshPointer
public HRESULT SetMeshPointer(CATMSHElement* iMeshElement)
Creates the link to the current unlinked explicit element with an element mesh pointer.
Parameters:
iMeshElement
The pointer of the mesh Element. This Mesh Element must be undeleted, not linked to any Explicit Element. This Explicit Element must not be linked to any Mesh ELement.
o operator =
public CATAnalysisExplicitElement operator =( const CATAnalysisExplicitData& iData)
Assignment operator.
o operator =
public CATAnalysisExplicitElement operator =( const CATAnalysisExplicitElement& iElement)
Assignment operator.

This object is included in the file: CATAnalysisExplicitElement.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit

Copyright © 2003, Dassault Systèmes. All rights reserved.