Public Types | Public Member Functions | Static Public Member Functions | List of all members
MeshedSurfaceProxy Class Reference

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

Public Types

typedef Face face_type
 
typedef point point_type
 

Public Member Functions

 ClassName ("MeshedSurfaceProxy")
 
 MeshedSurfaceProxy (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst=UList< surfZone >::null(), const labelUList &faceMap=labelUList::null(), const labelUList &faceIdLst=labelUList::null())
 
virtual ~MeshedSurfaceProxy ()=default
 
 declareMemberFunctionSelectionTable (void, MeshedSurfaceProxy, write, fileExtension,(const fileName &name, const MeshedSurfaceProxy< Face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options))
 
label size () const
 
const pointFieldpoints () const
 
const UList< Face > & surfFaces () const
 
const UList< surfZone > & surfZones () const
 
const labelUListfaceMap () const
 
const labelUListfaceIds () const
 
bool useFaceMap () const
 
bool useFaceIds () const
 
label nTriangles () const
 
virtual void write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
 
virtual void write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
 
virtual void write (const Time &t, const word &surfName=word::null) const
 

Static Public Member Functions

static wordHashSet writeTypes ()
 
static bool canWriteType (const word &fileType, bool verbose=false)
 
static void write (const fileName &name, const MeshedSurfaceProxy &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
 
static void write (const fileName &name, const word &fileType, const MeshedSurfaceProxy &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
 

Detailed Description

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

The constructor interface is fat and ugly, but is largely encapsulated by conversion operators in other classes.

Source files

Definition at line 78 of file MeshedSurface.H.

Member Typedef Documentation

◆ face_type

typedef Face face_type

Definition at line 82 of file MeshedSurfaceProxy.H.

◆ point_type

typedef point point_type

Definition at line 85 of file MeshedSurfaceProxy.H.

Constructor & Destructor Documentation

◆ MeshedSurfaceProxy()

MeshedSurfaceProxy ( const pointField pointLst,
const UList< Face > &  faceLst,
const UList< surfZone > &  zoneLst = UList<surfZone>::null(),
const labelUList faceMap = labelUList::null(),
const labelUList faceIdLst = labelUList::null() 
)

Definition at line 230 of file MeshedSurfaceProxy.C.

◆ ~MeshedSurfaceProxy()

virtual ~MeshedSurfaceProxy ( )
virtualdefault

Member Function Documentation

◆ ClassName()

ClassName ( "MeshedSurfaceProxy"  )

◆ writeTypes()

Foam::wordHashSet writeTypes ( )
static

Definition at line 32 of file MeshedSurfaceProxy.C.

Referenced by surfaceWriter::New().

Here is the caller graph for this function:

◆ canWriteType()

bool canWriteType ( const word fileType,
bool  verbose = false 
)
static

Definition at line 40 of file MeshedSurfaceProxy.C.

◆ declareMemberFunctionSelectionTable()

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

◆ write() [1/5]

static void write ( const fileName name,
const MeshedSurfaceProxy surf,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
)
static

◆ write() [2/5]

static void write ( const fileName name,
const word fileType,
const MeshedSurfaceProxy surf,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
)
static

◆ size()

label size ( ) const
inline

Definition at line 161 of file MeshedSurfaceProxy.H.

◆ points()

const pointField& points ( ) const
inline

◆ surfFaces()

const UList<Face>& surfFaces ( ) const
inline

◆ surfZones()

const UList<surfZone>& surfZones ( ) const
inline

◆ faceMap()

const labelUList& faceMap ( ) const
inline

◆ faceIds()

const labelUList& faceIds ( ) const
inline

Definition at line 193 of file MeshedSurfaceProxy.H.

Referenced by ABAQUSsurfaceFormat< Face >::write(), STARCDsurfaceFormat< Face >::write(), and NASsurfaceFormat< Face >::write().

Here is the caller graph for this function:

◆ useFaceMap()

bool useFaceMap ( ) const
inline

◆ useFaceIds()

bool useFaceIds ( ) const
inline

Definition at line 205 of file MeshedSurfaceProxy.H.

◆ nTriangles()

Foam::label nTriangles ( ) const
inline

Definition at line 249 of file MeshedSurfaceProxy.C.

References f().

Referenced by STLsurfaceFormat< Face >::writeBinary().

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

◆ write() [3/5]

virtual void write ( const fileName name,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
) const
inlinevirtual

Definition at line 218 of file MeshedSurfaceProxy.H.

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

Here is the call graph for this function:

◆ write() [4/5]

virtual void write ( const fileName name,
const word fileType,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
) const
inlinevirtual

Definition at line 230 of file MeshedSurfaceProxy.H.

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

Here is the call graph for this function:

◆ write() [5/5]

virtual void write ( const Time t,
const word surfName = word::null 
) const
virtual

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