Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
MeshedSurfaceProxy Class Reference

A proxy for writing MeshedSurface, UnsortedMeshedSurface and surfMesh to various file formats. More...

Collaboration diagram for MeshedSurfaceProxy:
Collaboration graph
[legend]

Public Types

typedef Face FaceType
 Face type used. More...
 

Public Member Functions

 ClassName ("MeshedSurfaceProxy")
 Runtime type information. More...
 
 MeshedSurfaceProxy (const pointField &, const List< Face > &, const List< surfZone > &=List< surfZone >(), const List< label > &faceMap=List< label >())
 Construct from component references. More...
 
virtual ~MeshedSurfaceProxy ()
 Destructor. More...
 
 declareMemberFunctionSelectionTable (void, MeshedSurfaceProxy, write, fileExtension,(const fileName &name, const MeshedSurfaceProxy< Face > &surf),(name, surf))
 
const pointField & points () const
 Return const access to the points. More...
 
const List< Face > & faces () const
 Return const access to the faces. More...
 
const List< surfZone > & surfZones () const
 Const access to the surface zones. More...
 
const List< label > & faceMap () const
 Const access to the faceMap, zero-sized when unused. More...
 
bool useFaceMap () const
 Use faceMap? More...
 
virtual void write (const fileName &name) const
 Generic write routine. Chooses writer based on extension. More...
 
virtual void write (const Time &, const word &surfName="") const
 Write to database. More...
 

Static Public Member Functions

static wordHashSet writeTypes ()
 The file format types that can be written via MeshedSurfaceProxy. More...
 
static bool canWriteType (const word &ext, const bool verbose=false)
 Can this file format type be written via MeshedSurfaceProxy? More...
 
static void write (const fileName &, const MeshedSurfaceProxy< Face > &)
 Write to file. More...
 

Private Attributes

const pointField & points_
 Private data. More...
 
const List< Face > & faces_
 
const List< surfZone > & zones_
 
const List< label > & faceMap_
 

Detailed Description

A proxy for writing MeshedSurface, UnsortedMeshedSurface and surfMesh to various file formats.

Source files

Definition at line 73 of file MeshedSurface.H.

Member Typedef Documentation

◆ FaceType

typedef Face FaceType

Face type used.

Definition at line 83 of file MeshedSurfaceProxy.H.

Constructor & Destructor Documentation

◆ MeshedSurfaceProxy()

MeshedSurfaceProxy ( const pointField &  pointLst,
const List< Face > &  faceLst,
const List< surfZone > &  zoneLst = List<surfZone>(),
const List< label > &  faceMap = List<label>() 
)

Construct from component references.

Definition at line 223 of file MeshedSurfaceProxy.C.

◆ ~MeshedSurfaceProxy()

~MeshedSurfaceProxy ( )
virtual

Destructor.

Definition at line 240 of file MeshedSurfaceProxy.C.

Member Function Documentation

◆ ClassName()

ClassName ( "MeshedSurfaceProxy"  )

Runtime type information.

◆ writeTypes()

Foam::wordHashSet writeTypes ( )
static

The file format types that can be written via MeshedSurfaceProxy.

Definition at line 36 of file MeshedSurfaceProxy.C.

Referenced by surfaceWriter::New().

Here is the caller graph for this function:

◆ canWriteType()

bool canWriteType ( const word &  ext,
const bool  verbose = false 
)
static

Can this file format type be written via MeshedSurfaceProxy?

Definition at line 44 of file MeshedSurfaceProxy.C.

◆ declareMemberFunctionSelectionTable()

declareMemberFunctionSelectionTable ( void  ,
MeshedSurfaceProxy  ,
write  ,
fileExtension  ,
(const fileName &name, const MeshedSurfaceProxy< Face > &surf)  ,
(name, surf)   
)

◆ write() [1/3]

static void write ( const fileName &  ,
const MeshedSurfaceProxy< Face > &   
)
static

Write to file.

Referenced by proxySurfaceWriter::write(), starcdSurfaceWriter::write(), MeshedSurfaceProxy::write(), and surfMesh::write().

Here is the caller graph for this function:

◆ points()

const pointField& points ( ) const
inline

Return const access to the points.

Definition at line 138 of file MeshedSurfaceProxy.H.

References MeshedSurfaceProxy::points_.

Referenced by X3DsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), VTKsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), STARCDsurfaceFormat< Face >::write(), OFSsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), and STLsurfaceFormat< Face >::writeBinary().

Here is the caller graph for this function:

◆ faces()

const List<Face>& faces ( ) const
inline

Return const access to the faces.

Definition at line 144 of file MeshedSurfaceProxy.H.

References MeshedSurfaceProxy::faces_.

Referenced by X3DsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), VTKsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), STARCDsurfaceFormat< Face >::write(), OFSsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), and STLsurfaceFormat< Face >::writeBinary().

Here is the caller graph for this function:

◆ surfZones()

const List<surfZone>& surfZones ( ) const
inline

Const access to the surface zones.

If zones are defined, they must be contiguous and cover the entire surface

Definition at line 152 of file MeshedSurfaceProxy.H.

Referenced by X3DsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), VTKsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), STARCDsurfaceFormat< Face >::write(), OFSsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), and STLsurfaceFormat< Face >::writeBinary().

Here is the caller graph for this function:

◆ faceMap()

const List<label>& faceMap ( ) const
inline

Const access to the faceMap, zero-sized when unused.

Definition at line 158 of file MeshedSurfaceProxy.H.

References MeshedSurfaceProxy::faceMap_.

Referenced by X3DsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), VTKsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), STARCDsurfaceFormat< Face >::write(), OFSsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), and STLsurfaceFormat< Face >::writeBinary().

Here is the caller graph for this function:

◆ useFaceMap()

bool useFaceMap ( ) const
inline

Use faceMap?

Definition at line 164 of file MeshedSurfaceProxy.H.

References MeshedSurfaceProxy::faceMap_, MeshedSurfaceProxy::faces_, and List::size().

Referenced by X3DsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), VTKsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), STARCDsurfaceFormat< Face >::write(), OFSsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), and STLsurfaceFormat< Face >::writeBinary().

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

◆ write() [2/3]

virtual void write ( const fileName &  name) const
inlinevirtual

Generic write routine. Chooses writer based on extension.

Definition at line 172 of file MeshedSurfaceProxy.H.

References Foam::name(), and MeshedSurfaceProxy::write().

Here is the call graph for this function:

◆ write() [3/3]

virtual void write ( const Time &  ,
const word &  surfName = "" 
) const
virtual

Write to database.

Field Documentation

◆ points_

const pointField& points_
private

Private data.

Definition at line 69 of file MeshedSurfaceProxy.H.

Referenced by MeshedSurfaceProxy::points().

◆ faces_

const List<Face>& faces_
private

Definition at line 71 of file MeshedSurfaceProxy.H.

Referenced by MeshedSurfaceProxy::faces(), and MeshedSurfaceProxy::useFaceMap().

◆ zones_

const List<surfZone>& zones_
private

Definition at line 73 of file MeshedSurfaceProxy.H.

◆ faceMap_

const List<label>& faceMap_
private

Definition at line 75 of file MeshedSurfaceProxy.H.

Referenced by MeshedSurfaceProxy::faceMap(), and MeshedSurfaceProxy::useFaceMap().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17