meshedSurfRef Class Reference

Implements a meshed surface by referencing another meshed surface or faces/points components. More...

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

Public Member Functions

 meshedSurfRef ()
 Default construct. More...
 
 meshedSurfRef (const meshedSurf &s)
 Construct as reference to a meshedSurf. More...
 
 meshedSurfRef (const pointField &points, const faceList &faces, const labelList &zoneIds=labelList::null(), const labelList &faceIds=labelList::null())
 Construct from components. More...
 
virtual ~meshedSurfRef ()=default
 Destructor. More...
 
bool valid () const
 Contains a valid reference? More...
 
const pointFieldpoints0 () const
 The original points used for the surface. More...
 
virtual const pointFieldpoints () const
 The points used for the surface. More...
 
virtual const faceListfaces () const
 The faces used for the surface. More...
 
virtual const labelListzoneIds () const
 Per-face zone/region information. More...
 
virtual const labelListfaceIds () const
 Per-face identifier (eg, element Id) More...
 
void clear ()
 Invalid by redirecting to null objects. More...
 
void reset (const meshedSurf &s)
 Reset surface. More...
 
void reset (const pointField &points, const faceList &faces, const labelList &zoneIds=labelList::null(), const labelList &faceIds=labelList::null())
 Reset components. More...
 
void resetPoints ()
 Reset changes in point positions. More...
 
void movePoints (pointField &&pts)
 Change point positions. More...
 
void movePoints (const tmp< pointField > &tpts)
 Change point positions. More...
 
void scalePoints (const scalar scaleFactor)
 Scale points: ignore unity and non-positive factors. More...
 
- Public Member Functions inherited from meshedSurf
constexpr meshedSurf () noexcept=default
 Default construct. More...
 
virtual ~meshedSurf ()=default
 Destructor. More...
 
virtual const pointFieldpoints () const =0
 The points used for the surface. More...
 
virtual const faceListfaces () const =0
 The faces used for the surface. More...
 
virtual const labelListzoneIds () const
 Per-face zone/region information. More...
 
virtual const labelListfaceIds () const
 Per-face identifier (eg, element Id) More...
 

Detailed Description

Implements a meshed surface by referencing another meshed surface or faces/points components.

In addition to the referencing, supports simple moving/scaling of points (uses a deep-copy).

Definition at line 53 of file meshedSurfRef.H.

Constructor & Destructor Documentation

◆ meshedSurfRef() [1/3]

meshedSurfRef ( )
inline

Default construct.

Definition at line 77 of file meshedSurfRef.H.

◆ meshedSurfRef() [2/3]

meshedSurfRef ( const meshedSurf s)
inlineexplicit

Construct as reference to a meshedSurf.

Definition at line 86 of file meshedSurfRef.H.

References refPtr< T >::cref(), and s().

Here is the call graph for this function:

◆ meshedSurfRef() [3/3]

meshedSurfRef ( const pointField points,
const faceList faces,
const labelList zoneIds = labelList::null(),
const labelList faceIds = labelList::null() 
)
inline

Construct from components.

Definition at line 94 of file meshedSurfRef.H.

◆ ~meshedSurfRef()

virtual ~meshedSurfRef ( )
virtualdefault

Destructor.

Member Function Documentation

◆ valid()

bool valid ( ) const
inline

Contains a valid reference?

Definition at line 116 of file meshedSurfRef.H.

References Foam::notNull().

Here is the call graph for this function:

◆ points0()

const pointField & points0 ( ) const
inline

The original points used for the surface.

Definition at line 122 of file meshedSurfRef.H.

References refPtr< T >::cref().

Referenced by meshedSurfRef::points(), and meshedSurfRef::scalePoints().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ points()

virtual const pointField & points ( ) const
inlinevirtual

The points used for the surface.

Implements meshedSurf.

Definition at line 128 of file meshedSurfRef.H.

References UList< T >::empty(), and meshedSurfRef::points0().

Referenced by meshedSurfRef::reset(), foamWriter::write(), proxyWriter::write(), rawWriter::write(), starcdWriter::write(), vtkWriter::write(), x3dWriter::write(), ensightWriter::writeCollated(), abaqusWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), x3dWriter::writeTemplate(), and ensightWriter::writeUncollated().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ faces()

virtual const faceList & faces ( ) const
inlinevirtual

The faces used for the surface.

Implements meshedSurf.

Definition at line 134 of file meshedSurfRef.H.

References refPtr< T >::cref().

Referenced by meshedSurfRef::reset(), foamWriter::write(), proxyWriter::write(), rawWriter::write(), starcdWriter::write(), vtkWriter::write(), x3dWriter::write(), ensightWriter::writeCollated(), abaqusWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), x3dWriter::writeTemplate(), and ensightWriter::writeUncollated().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ zoneIds()

virtual const labelList & zoneIds ( ) const
inlinevirtual

Per-face zone/region information.

Reimplemented from meshedSurf.

Definition at line 140 of file meshedSurfRef.H.

References refPtr< T >::cref().

Referenced by meshedSurfRef::reset().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ faceIds()

virtual const labelList & faceIds ( ) const
inlinevirtual

Per-face identifier (eg, element Id)

Reimplemented from meshedSurf.

Definition at line 146 of file meshedSurfRef.H.

References refPtr< T >::cref().

Referenced by meshedSurfRef::reset(), starcdWriter::write(), abaqusWriter::writeTemplate(), nastranWriter::writeTemplate(), and starcdWriter::writeTemplate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clear()

void clear ( )
inline

Invalid by redirecting to null objects.

Definition at line 152 of file meshedSurfRef.H.

References List< T >::clear(), and refPtr< T >::reset().

Referenced by surfaceWriter::adjustSurface(), and meshedSurfRef::reset().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reset() [1/2]

void reset ( const meshedSurf s)
inline

Reset surface.

Definition at line 163 of file meshedSurfRef.H.

References meshedSurfRef::clear(), refPtr< T >::cref(), and s().

Here is the call graph for this function:

◆ reset() [2/2]

void reset ( const pointField points,
const faceList faces,
const labelList zoneIds = labelList::null(),
const labelList faceIds = labelList::null() 
)
inline

Reset components.

Definition at line 170 of file meshedSurfRef.H.

References List< T >::clear(), meshedSurfRef::faceIds(), meshedSurfRef::faces(), meshedSurfRef::points(), refPtr< T >::reset(), and meshedSurfRef::zoneIds().

Here is the call graph for this function:

◆ resetPoints()

void resetPoints ( )
inline

Reset changes in point positions.

Definition at line 188 of file meshedSurfRef.H.

References List< T >::clear().

Here is the call graph for this function:

◆ movePoints() [1/2]

void movePoints ( pointField &&  pts)
inline

Change point positions.

Definition at line 194 of file meshedSurfRef.H.

References List< T >::transfer().

Here is the call graph for this function:

◆ movePoints() [2/2]

void movePoints ( const tmp< pointField > &  tpts)
inline

Change point positions.

Definition at line 200 of file meshedSurfRef.H.

References List< T >::clear(), and tmp< T >::clear().

Here is the call graph for this function:

◆ scalePoints()

void scalePoints ( const scalar  scaleFactor)
inline

Scale points: ignore unity and non-positive factors.

Definition at line 211 of file meshedSurfRef.H.

References UList< T >::empty(), Foam::equal(), and meshedSurfRef::points0().

Here is the call graph for this function:

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