VTK  9.0.20200712
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkLagrangeHexahedron Class Reference

A 3D cell that represents an arbitrary order Lagrange hex. More...

#include <vtkLagrangeHexahedron.h>

Inheritance diagram for vtkLagrangeHexahedron:
[legend]
Collaboration diagram for vtkLagrangeHexahedron:
[legend]

Public Types

typedef vtkHigherOrderHexahedron Superclass
 
- Public Types inherited from vtkHigherOrderHexahedron
typedef vtkNonLinearCell Superclass
 
- Public Types inherited from vtkNonLinearCell
typedef vtkCell Superclass
 
- Public Types inherited from vtkCell
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkLagrangeHexahedronNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetCellType () override
 Return the type of cell. More...
 
vtkCellGetEdge (int edgeId) override
 Return the edge cell from the edgeId of the cell. More...
 
vtkCellGetFace (int faceId) override
 Return the face cell from the faceId of the cell. More...
 
void InterpolateFunctions (const double pcoords[3], double *weights) override
 
void InterpolateDerivs (const double pcoords[3], double *derivs) override
 
vtkHigherOrderCurvegetEdgeCell () override
 
vtkHigherOrderQuadrilateralgetFaceCell () override
 
vtkHigherOrderInterpolationgetInterp () override
 
- Public Member Functions inherited from vtkHigherOrderHexahedron
vtkHigherOrderHexahedronNewInstance () const
 
int GetCellDimension () override
 Return the topological dimensional of the cell (0,1,2, or 3). More...
 
int RequiresInitialization () override
 Some cells require initialization prior to access. More...
 
int GetNumberOfEdges () override
 Return the number of edges in the cell. More...
 
int GetNumberOfFaces () override
 Return the number of faces in the cell. More...
 
void SetEdgeIdsAndPoints (int edgeId, const std::function< void(const vtkIdType &)> &set_number_of_ids_and_points, const std::function< void(const vtkIdType &, const vtkIdType &)> &set_ids_and_points)
 
void SetFaceIdsAndPoints (vtkHigherOrderQuadrilateral *result, int faceId, const std::function< void(const vtkIdType &)> &set_number_of_ids_and_points, const std::function< void(const vtkIdType &, const vtkIdType &)> &set_ids_and_points)
 
void Initialize () override
 
int CellBoundary (int subId, const double pcoords[3], vtkIdList *pts) override
 Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell. More...
 
int EvaluatePosition (const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
 Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; evaluate parametric coordinates, sub-cell id (!=0 only if cell is composite), distance squared of point x[3] to cell (in particular, the sub-cell indicated), closest point on cell to x[3] (unless closestPoint is null, in which case, the closest point and dist2 are not found), and interpolation weights in cell. More...
 
void EvaluateLocation (int &subId, const double pcoords[3], double x[3], double *weights) override
 Determine global coordinate (x[3]) from subId and parametric coordinates. More...
 
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override
 Generate contouring primitives. More...
 
void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
 Cut (or clip) the cell based on the input cellScalars and the specified value. More...
 
int IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
 Intersect with a ray. More...
 
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts) override
 Generate simplices of proper dimension. More...
 
void Derivatives (int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
 Compute derivatives given cell subId and parametric coordinates. More...
 
void SetParametricCoords ()
 
double * GetParametricCoords () override
 Return a contiguous array of parametric coordinates of the points defining this cell. More...
 
int GetParametricCenter (double center[3]) override
 Return center of the cell in parametric coordinates. More...
 
double GetParametricDistance (const double pcoords[3]) override
 Return the distance of the parametric coordinate provided to the cell. More...
 
virtual void SetOrderFromCellData (vtkCellData *cell_data, const vtkIdType numPts, const vtkIdType cell_id)
 
virtual void SetUniformOrderFromNumPoints (const vtkIdType numPts)
 
virtual void SetOrder (const int s, const int t, const int u)
 
virtual const int * GetOrder ()
 
virtual int GetOrder (int i)
 
bool SubCellCoordinatesFromId (vtkVector3i &ijk, int subId)
 
bool SubCellCoordinatesFromId (int &i, int &j, int &k, int subId)
 
int PointIndexFromIJK (int i, int j, int k)
 
bool TransformApproxToCellParams (int subCell, double *pcoords)
 
bool TransformFaceToCellParams (int bdyFace, double *pcoords)
 
- Public Member Functions inherited from vtkNonLinearCell
vtkNonLinearCellNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int IsLinear () override
 Non-linear cells require special treatment (tessellation) when converting to graphics primitives (during mapping). More...
 
- Public Member Functions inherited from vtkCell
vtkCellNewInstance () const
 
void Initialize (int npts, const vtkIdType *pts, vtkPoints *p)
 Initialize cell from outside with point ids and point coordinates specified. More...
 
void Initialize (int npts, vtkPoints *p)
 Initialize the cell with point coordinates specified. More...
 
virtual void ShallowCopy (vtkCell *c)
 Copy this cell by reference counting the internal data structures. More...
 
virtual void DeepCopy (vtkCell *c)
 Copy this cell by completely copying internal data structures. More...
 
virtual int IsExplicitCell ()
 Explicit cells require additional representational information beyond the usual cell type and connectivity list information. More...
 
virtual int RequiresExplicitFaceRepresentation ()
 Determine whether the cell requires explicit face representation, and methods for setting and getting the faces (see vtkPolyhedron for example usage of these methods). More...
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdTypeGetFaces ()
 
vtkPointsGetPoints ()
 Get the point coordinates for the cell. More...
 
vtkIdType GetNumberOfPoints ()
 Return the number of points in the cell. More...
 
vtkIdListGetPointIds ()
 Return the list of point ids defining the cell. More...
 
vtkIdType GetPointId (int ptId)
 For cell point i, return the actual point id. More...
 
virtual void Inflate (double dist)
 Inflates the cell by dist. More...
 
virtual double ComputeBoundingSphere (double center[3]) const
 Computes the bounding sphere of the cell. More...
 
virtual int IntersectWithCell (vtkCell *other, double tol=0.0)
 Intersects with an other cell. More...
 
virtual int IntersectWithCell (vtkCell *other, const vtkBoundingBox &boudingBox, const vtkBoundingBox &otherBoundingBox, double tol=0.0)
 
void GetBounds (double bounds[6])
 Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...
 
double * GetBounds ()
 Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...
 
double GetLength2 ()
 Compute Length squared of cell (i.e., bounding box diagonal squared). More...
 
virtual int IsPrimaryCell ()
 Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet). More...
 
virtual void InterpolateFunctions (const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
 Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this level. More...
 
virtual void InterpolateDerivs (const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkLagrangeHexahedronNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLagrangeHexahedronSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHigherOrderHexahedron
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHigherOrderHexahedronSafeDownCast (vtkObjectBase *o)
 
static int PointIndexFromIJK (int i, int j, int k, const int *order)
 
static vtkIdType NodeNumberingMappingFromVTK8To9 (const int order[3], const vtkIdType node_id_vtk8)
 
- Static Public Member Functions inherited from vtkNonLinearCell
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkNonLinearCellSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCell
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
vtkHexahedronGetApproximateHex (int subId, vtkDataArray *scalarsIn=nullptr, vtkDataArray *scalarsOut=nullptr) override
 
 vtkLagrangeHexahedron ()
 
 ~vtkLagrangeHexahedron () override
 
- Protected Member Functions inherited from vtkHigherOrderHexahedron
 vtkHigherOrderHexahedron ()
 
 ~vtkHigherOrderHexahedron () override
 
vtkHexahedronGetApprox ()
 
void PrepareApproxData (vtkPointData *pd, vtkCellData *cd, vtkIdType cellId, vtkDataArray *cellScalars)
 
- Protected Member Functions inherited from vtkNonLinearCell
 vtkNonLinearCell ()
 
 ~vtkNonLinearCell () override=default
 
- Protected Member Functions inherited from vtkCell
 vtkCell ()
 
 ~vtkCell () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkNew< vtkLagrangeQuadrilateralFaceCell
 
vtkNew< vtkLagrangeCurveEdgeCell
 
vtkNew< vtkLagrangeInterpolationInterp
 
- Protected Attributes inherited from vtkHigherOrderHexahedron
int Order [4]
 
vtkSmartPointer< vtkPointsPointParametricCoordinates
 
vtkSmartPointer< vtkHexahedronApprox
 
vtkSmartPointer< vtkPointDataApproxPD
 
vtkSmartPointer< vtkCellDataApproxCD
 
vtkNew< vtkDoubleArrayCellScalars
 
vtkNew< vtkDoubleArrayScalars
 
vtkNew< vtkPointsTmpPts
 
vtkNew< vtkIdListTmpIds
 
- Protected Attributes inherited from vtkCell
double Bounds [6]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkCell
vtkPointsPoints
 
vtkIdListPointIds
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

A 3D cell that represents an arbitrary order Lagrange hex.

vtkLagrangeHexahedron is a concrete implementation of vtkCell to represent a 3D hexahedron using Lagrange shape functions of user specified order.

See also
vtkHexahedron

Definition at line 47 of file vtkLagrangeHexahedron.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkLagrangeHexahedron.h.

Constructor & Destructor Documentation

◆ vtkLagrangeHexahedron()

vtkLagrangeHexahedron::vtkLagrangeHexahedron ( )
protected

◆ ~vtkLagrangeHexahedron()

vtkLagrangeHexahedron::~vtkLagrangeHexahedron ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLagrangeHexahedron* vtkLagrangeHexahedron::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkLagrangeHexahedron::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkLagrangeHexahedron::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkHigherOrderHexahedron.

◆ SafeDownCast()

static vtkLagrangeHexahedron* vtkLagrangeHexahedron::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLagrangeHexahedron::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHigherOrderHexahedron.

◆ NewInstance()

vtkLagrangeHexahedron* vtkLagrangeHexahedron::NewInstance ( ) const

◆ PrintSelf()

void vtkLagrangeHexahedron::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkHigherOrderHexahedron.

◆ GetCellType()

int vtkLagrangeHexahedron::GetCellType ( )
inlineoverridevirtual

Return the type of cell.

Implements vtkHigherOrderHexahedron.

Definition at line 54 of file vtkLagrangeHexahedron.h.

◆ GetEdge()

vtkCell* vtkLagrangeHexahedron::GetEdge ( int  edgeId)
overridevirtual

Return the edge cell from the edgeId of the cell.

Implements vtkHigherOrderHexahedron.

◆ GetFace()

vtkCell* vtkLagrangeHexahedron::GetFace ( int  faceId)
overridevirtual

Return the face cell from the faceId of the cell.

The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.

Warning
Repeat calls to this function for different face ids will change the data stored in the internal member object whose pointer is returned by this function.
THIS METHOD IS NOT THREAD SAFE.

Implements vtkHigherOrderHexahedron.

◆ InterpolateFunctions()

void vtkLagrangeHexahedron::InterpolateFunctions ( const double  pcoords[3],
double *  weights 
)
overridevirtual

◆ InterpolateDerivs()

void vtkLagrangeHexahedron::InterpolateDerivs ( const double  pcoords[3],
double *  derivs 
)
overridevirtual

◆ getEdgeCell()

vtkHigherOrderCurve* vtkLagrangeHexahedron::getEdgeCell ( )
overridevirtual

◆ getFaceCell()

vtkHigherOrderQuadrilateral* vtkLagrangeHexahedron::getFaceCell ( )
overridevirtual

◆ getInterp()

vtkHigherOrderInterpolation* vtkLagrangeHexahedron::getInterp ( )
overridevirtual

◆ GetApproximateHex()

vtkHexahedron* vtkLagrangeHexahedron::GetApproximateHex ( int  subId,
vtkDataArray scalarsIn = nullptr,
vtkDataArray scalarsOut = nullptr 
)
overrideprotectedvirtual

Member Data Documentation

◆ FaceCell

vtkNew<vtkLagrangeQuadrilateral> vtkLagrangeHexahedron::FaceCell
protected

Definition at line 69 of file vtkLagrangeHexahedron.h.

◆ EdgeCell

vtkNew<vtkLagrangeCurve> vtkLagrangeHexahedron::EdgeCell
protected

Definition at line 70 of file vtkLagrangeHexahedron.h.

◆ Interp

vtkNew<vtkLagrangeInterpolation> vtkLagrangeHexahedron::Interp
protected

Definition at line 71 of file vtkLagrangeHexahedron.h.


The documentation for this class was generated from the following file: