Public Types | Public Member Functions | Static Public Member Functions | List of all members
MeshedSurfaceProxy< Face > Class Template Reference

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

Inheritance diagram for MeshedSurfaceProxy< Face >:
Inheritance graph
[legend]
Collaboration diagram for MeshedSurfaceProxy< Face >:
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 pointFieldpoints () 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...
 
- Public Member Functions inherited from surfaceFormatsCore
 surfaceFormatsCore ()
 Construct null. More...
 
virtual ~surfaceFormatsCore ()
 Destructor. 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...
 
- Static Public Member Functions inherited from surfaceFormatsCore
static bool checkSupport (const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
 
static fileName localMeshFileName (const word &surfName="")
 Return the local file name (within time directory) More...
 
static fileName findMeshInstance (const Time &, const word &surfName="")
 Find instance with surfName. More...
 
static fileName findMeshFile (const Time &, const word &surfName="")
 Find mesh file with surfName. More...
 

Additional Inherited Members

- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Static Protected Member Functions inherited from surfaceFormatsCore
template<class Container >
static List< surfZoneoneZone (const Container &container, const word &name="zone0")
 Return a list with a single entry,. More...
 
static string getLineNoComment (IFstream &)
 Read non-comment line. More...
 

Detailed Description

template<class Face>
class Foam::MeshedSurfaceProxy< Face >

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

typedef Face FaceType

Face type used.

Definition at line 83 of file MeshedSurfaceProxy.H.

Constructor & Destructor Documentation

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 225 of file MeshedSurfaceProxy.C.

Referenced by MeshedSurfaceProxy< Face >::write().

Here is the caller graph for this function:

~MeshedSurfaceProxy ( )
virtual

Destructor.

Definition at line 242 of file MeshedSurfaceProxy.C.

Member Function Documentation

ClassName ( "MeshedSurfaceProxy< Face >"  )

Runtime type information.

Foam::wordHashSet writeTypes ( )
static

The file format types that can be written via MeshedSurfaceProxy.

Definition at line 36 of file MeshedSurfaceProxy.C.

References MeshedSurfaceProxy< Face >::canWriteType().

Referenced by surfaceWriter::New().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

References Foam::endl(), Foam::exit(), fileName::ext(), Foam::FatalError, FatalErrorIn, Foam::Info, Foam::name(), Foam::nl, and MeshedSurfaceProxy< Face >::write().

Referenced by MeshedSurfaceProxy< Face >::writeTypes().

Here is the call graph for this function:

Here is the caller graph for this function:

declareMemberFunctionSelectionTable ( void  ,
MeshedSurfaceProxy< Face >  ,
write  ,
fileExtension  ,
( const fileName &name, const MeshedSurfaceProxy< Face > &surf )  ,
(name, surf)   
)
static void write ( const fileName ,
const MeshedSurfaceProxy< Face > &   
)
static
const pointField& points ( ) const
inline
const List<Face>& faces ( ) const
inline
const List<surfZone>& surfZones ( ) const
inline
const List<label>& faceMap ( ) const
inline
bool useFaceMap ( ) const
inline
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 MeshedSurfaceProxy< Face >::write().

Here is the call graph for this function:

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

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