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

#include <meshedSurfRef.H>

Inheritance diagram for meshedSurfRef:

Collaboration diagram for meshedSurfRef:

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

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 47 of file meshedSurfRef.H.

Constructor & Destructor Documentation

◆ meshedSurfRef() [1/3]

meshedSurfRef ( )

inline

Default construct.

Definition at line 79 of file meshedSurfRef.H.

Referenced by meshedSurfRef().

Here is the caller graph for this function:

◆ meshedSurfRef() [2/3]

meshedSurfRef ( const meshedSurf & s )

inlineexplicit

Construct as reference to a meshedSurf.

Definition at line 90 of file meshedSurfRef.H.

References meshedSurf::meshedSurf(), meshedSurfRef(), 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 100 of file meshedSurfRef.H.

References faceIds(), faces(), List< label >::null(), points(), and zoneIds().

Here is the call graph for this function:

◆ ~meshedSurfRef()

virtual ~meshedSurfRef ( )

virtualdefault

Destructor.

Member Function Documentation

◆ good()

bool good ( ) const

inline

Contains a valid reference?

Definition at line 126 of file meshedSurfRef.H.

References Foam::notNull().

Referenced by valid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valid()

bool valid ( ) const

inline

Contains a valid reference?

Definition at line 134 of file meshedSurfRef.H.

References good().

Here is the call graph for this function:

◆ points0()

const pointField & points0 ( ) const

inline

The original points used for the surface.

Definition at line 139 of file meshedSurfRef.H.

Referenced by points(), and scalePoints().

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 147 of file meshedSurfRef.H.

References 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 155 of file meshedSurfRef.H.

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 caller graph for this function:

◆ zoneIds()

virtual const labelList & zoneIds ( ) const

inlinevirtual

Per-face zone/region information.

Reimplemented from meshedSurf.

Definition at line 163 of file meshedSurfRef.H.

Referenced by meshedSurfRef(), and reset().

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 171 of file meshedSurfRef.H.

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

Here is the caller graph for this function:

◆ clear()

void clear ( )

inline

Invalid by redirecting to null objects.

Definition at line 179 of file meshedSurfRef.H.

References Field< vector >::null(), List< face >::null(), and List< label >::null().

Referenced by 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 192 of file meshedSurfRef.H.

References clear(), meshedSurf::meshedSurf(), 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 201 of file meshedSurfRef.H.

References faceIds(), faces(), List< label >::null(), points(), and zoneIds().

Here is the call graph for this function:

◆ resetPoints()

void resetPoints ( )

inline

Reset changes in point positions.

Definition at line 221 of file meshedSurfRef.H.

◆ movePoints() [1/2]

void movePoints ( pointField && pts )

inline

Change point positions.

Definition at line 229 of file meshedSurfRef.H.

References pts.

◆ movePoints() [2/2]

void movePoints ( const tmp< pointField > & tpts )

inline

Change point positions.

Definition at line 237 of file meshedSurfRef.H.

References 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 250 of file meshedSurfRef.H.

References Foam::equal(), and points0().

Here is the call graph for this function:

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

src/surfMesh/meshedSurf/meshedSurfRef.H

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ meshedSurfRef() [1/3]

◆ meshedSurfRef() [2/3]

◆ meshedSurfRef() [3/3]

◆ ~meshedSurfRef()

Member Function Documentation

◆ good()

◆ valid()

◆ points0()

◆ points()

◆ faces()

◆ zoneIds()

◆ faceIds()

◆ clear()

◆ reset() [1/2]

◆ reset() [2/2]

◆ resetPoints()

◆ movePoints() [1/2]

◆ movePoints() [2/2]

◆ scalePoints()