AC3DsurfaceFormat< Face > Class Template Reference

Read/write AC3D format. More...

Inheritance diagram for AC3DsurfaceFormat< Face >:
[legend]
Collaboration diagram for AC3DsurfaceFormat< Face >:
[legend]

Public Member Functions

 AC3DsurfaceFormat (const fileName &filename)
 Construct from file name. More...
 
virtual ~AC3DsurfaceFormat ()=default
 Destructor. More...
 
virtual bool read (const fileName &filename)
 Read from file. More...
 
virtual void write (const fileName &name, const dictionary &options) const
 Write surface mesh to file. More...
 
- Public Member Functions inherited from MeshedSurface< Face >
 ClassName ("MeshedSurface")
 Runtime type information. More...
 
 MeshedSurface ()
 Construct null, an empty surface. More...
 
 MeshedSurface (const MeshedSurface &surf)
 Copy construct. More...
 
 MeshedSurface (const UnsortedMeshedSurface< Face > &surf)
 Copy construct from an UnsortedMeshedSurface. More...
 
 MeshedSurface (MeshedSurface &&surf)
 Move construct. More...
 
 MeshedSurface (UnsortedMeshedSurface< Face > &&surf)
 Move construct from an UnsortedMeshedSurface. More...
 
 MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst)
 Copy construct from components (points, faces, zones). More...
 
 MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst)
 Move construct from components (points, faces). More...
 
 MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
 Copy construct from components (points, faces). More...
 
 MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
 Move construct from components (points, faces). More...
 
 MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false)
 Construct from a boundary mesh with local points/faces. More...
 
 MeshedSurface (const surfMesh &mesh)
 Construct from a surfMesh. More...
 
 MeshedSurface (const fileName &name)
 Construct from file name (uses extension to determine type) More...
 
 MeshedSurface (const fileName &name, const word &ext)
 Construct from file name (uses extension to determine type) More...
 
 MeshedSurface (Istream &is)
 Construct from Istream. More...
 
 MeshedSurface (const Time &runTime, const word &surfName=word::null)
 Construct from database. More...
 
 declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name))
 
virtual ~MeshedSurface ()
 Destructor. More...
 
 declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf, const dictionary &options),(name, surf, options))
 
label size () const
 The surface size is the number of faces. More...
 
const List< Face > & surfFaces () const
 Return const access to the faces. More...
 
const surfZoneListsurfZones () const
 Const access to the surface zones. More...
 
const vectorFieldSf () const
 Face area vectors (normals) More...
 
const scalarFieldmagSf () const
 Face area magnitudes. More...
 
const vectorFieldCf () const
 Face centres. More...
 
virtual void clear ()
 Clear all storage. More...
 
virtual void addZones (const UList< surfZone > &, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void addZones (const labelUList &sizes, const bool cullEmpty=false)
 Add surface zones. More...
 
bool addZonesToFaces ()
 Propagate zone information on face regions. More...
 
virtual void removeZones ()
 Remove surface zones. More...
 
virtual void movePoints (const pointField &newPoints)
 Move points. More...
 
virtual void scalePoints (const scalar scaleFactor)
 Scale points. A non-positive factor is ignored. More...
 
virtual void cleanup (const bool verbose)
 Remove invalid faces. More...
 
virtual bool stitchFaces (const scalar tol=SMALL, const bool verbose=false)
 
virtual bool checkFaces (const bool verbose=false)
 
virtual label nTriangles () const
 Count number of triangles. More...
 
virtual label nTriangles (List< label > &faceMap) const
 Count number of triangles, returning a face map of original ids. More...
 
virtual label triangulate ()
 Triangulate in-place, returning the number of triangles added. More...
 
virtual label triangulate (List< label > &faceMap)
 Triangulate in-place, returning the number of triangles added. More...
 
template<class BoolListType >
MeshedSurface subsetMesh (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
 Return new surface. More...
 
MeshedSurface subsetMesh (const bitSet &include) const
 Return new surface. More...
 
MeshedSurface subsetMesh (const labelHashSet &include) const
 Return new surface. More...
 
void swap (MeshedSurface< Face > &surf)
 Swap contents. More...
 
void transfer (pointField &pointLst, List< Face > &faceLst)
 Transfer the components. More...
 
void transfer (MeshedSurface< Face > &surf)
 Transfer the contents of the argument and annul the argument. More...
 
void transfer (UnsortedMeshedSurface< Face > &surf)
 Transfer the contents of the argument and annul the argument. More...
 
autoPtr< MeshedSurface< Face > > releaseGeom ()
 Release (clear) geometry and return for reuse. More...
 
void swapFaces (List< Face > &faces)
 Swap the stored faces. More...
 
void swapPoints (pointField &points)
 Swap the stored points. More...
 
void swapZones (surfZoneList &zones)
 Swap the stored zones. More...
 
bool read (const fileName &name, const word &ext)
 Read from file. Chooses reader based on explicit extension. More...
 
void writeStats (Ostream &os) const
 
void write (const Time &t, const word &surfName=word::null) const
 Write to database. More...
 
void operator= (const MeshedSurface< Face > &surf)
 Copy assignment. More...
 
void operator= (MeshedSurface< Face > &&surf)
 Move assignment. More...
 
 operator MeshedSurfaceProxy< Face > () const
 Conversion operator to MeshedSurfaceProxy. More...
 
template<class Face>
 MeshedSurface (const MeshedSurface< Face > &surf)
 
template<class Face>
 MeshedSurface (MeshedSurface< Face > &&surf)
 
template<class BoolListType >
Foam::MeshedSurface< Face > subsetMesh (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
 
template<>
bool addZonesToFaces ()
 Specialization for labelledTri. More...
 
template<>
bool addZonesToFaces ()
 

Static Public Member Functions

static void write (const fileName &filename, const MeshedSurfaceProxy< Face > &surf, const dictionary &options=dictionary::null)
 Write surface mesh components by proxy. More...
 
static void write (const fileName &filename, const UnsortedMeshedSurface< Face > &surf, const dictionary &options=dictionary::null)
 Write UnsortedMeshedSurface, the output is always sorted by zones. More...
 
- Static Public Member Functions inherited from MeshedSurface< Face >
static bool canRead (const fileName &name, bool verbose=false)
 Can we read this file format? More...
 
static bool canReadType (const word &ext, bool verbose=false)
 Can we read this file format? More...
 
static bool canWriteType (const word &ext, bool verbose=false)
 Can we write this file format? More...
 
static wordHashSet readTypes ()
 Known readable file-types. More...
 
static wordHashSet writeTypes ()
 Known writable file-types. More...
 
static autoPtr< MeshedSurfaceNew (const fileName &name, const word &ext)
 Select constructed from filename (explicit extension) More...
 
static autoPtr< MeshedSurfaceNew (const fileName &name)
 Select constructed from filename (implicit extension) More...
 
static void write (const fileName &name, const MeshedSurface< Face > &surf, const dictionary &options=dictionary::null)
 Write to file, selecting writer based on its extension. More...
 
static void write (const fileName &name, const word &ext, const MeshedSurface< Face > &surf, const dictionary &options=dictionary::null)
 Write to file, selecting writer based on the given extension. More...
 

Additional Inherited Members

- Public Types inherited from MeshedSurface< Face >
typedef Face FaceType
 Face type used. More...
 
- Protected Member Functions inherited from MeshedSurface< Face >
void transcribe (MeshedSurface< face > &surf)
 Transfer points/zones from 'face' to other other shapes. More...
 
void checkZones ()
 Basic sanity check on zones. More...
 
pointFieldstoredPoints ()
 Non-const access to global points. More...
 
List< Face > & storedFaces ()
 Non-const access to the faces. More...
 
surfZoneListstoredZones ()
 Non-const access to the zones. More...
 
void sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, const bool sorted)
 Sort faces by zones and store sorted faces. More...
 
virtual void remapFaces (const labelUList &faceMap)
 Set new zones from faceMap. More...
 
template<>
void transcribe (MeshedSurface< face > &surf)
 
template<>
void transcribe (MeshedSurface< face > &surf)
 
template<>
void transcribe (MeshedSurface< face > &surf)
 
- Static Protected Member Functions inherited from AC3DsurfaceFormatCore
template<class Type >
static Type parse (const string &str)
 Read a type via IStringStream. More...
 
static bool readCmd (IFstream &is, string &cmd, string &args)
 Read cmd, args from IFstream. More...
 
static bool cueTo (IFstream &, const string &cmd, string &args)
 Read up to a line starting with cmd. Sets args to rest of line. More...
 
static string cueToOrDie (IFstream &, const string &cmd, const string &errorMsg=string::null)
 Like cueTo(), but FatalError if not found. More...
 
static void writeHeader (Ostream &os, const UList< surfZone > &zones)
 Write header with materials for each zone. More...
 

Detailed Description

template<class Face>
class Foam::fileFormats::AC3DsurfaceFormat< Face >

Read/write AC3D format.

http://www.inivis.com/ac3d/man/ac3dfileformat.html

Note
On input, the faces are already organized as zones. The output is always sorted by zones. In the absence of zones, a single zone will be assigned.
Source files

Definition at line 64 of file AC3DsurfaceFormat.H.

Constructor & Destructor Documentation

◆ AC3DsurfaceFormat()

AC3DsurfaceFormat ( const fileName filename)

Construct from file name.

Definition at line 38 of file AC3DsurfaceFormat.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ ~AC3DsurfaceFormat()

virtual ~AC3DsurfaceFormat ( )
virtualdefault

Destructor.

Member Function Documentation

◆ write() [1/3]

void write ( const fileName filename,
const MeshedSurfaceProxy< Face > &  surf,
const dictionary options = dictionary::null 
)
static

Write surface mesh components by proxy.

Definition at line 309 of file AC3DsurfaceFormat.C.

References Foam::exit(), MeshedSurfaceProxy< Face >::faceMap(), Foam::FatalError, FatalErrorInFunction, IOstream::good(), zone::name(), Foam::name(), Foam::foamVersion::patch, MeshedSurfaceProxy< Face >::points(), MeshedSurfaceProxy< Face >::surfFaces(), MeshedSurfaceProxy< Face >::surfZones(), MeshedSurfaceProxy< Face >::useFaceMap(), Foam::writeHeader(), and Foam::writeZone().

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

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

◆ write() [2/3]

void write ( const fileName filename,
const UnsortedMeshedSurface< Face > &  surf,
const dictionary options = dictionary::null 
)
static

Write UnsortedMeshedSurface, the output is always sorted by zones.

Definition at line 380 of file AC3DsurfaceFormat.C.

References Foam::exit(), Foam::faceMap(), Foam::FatalError, FatalErrorInFunction, IOstream::good(), zone::name(), Foam::name(), Foam::foamVersion::patch, UnsortedMeshedSurface< Face >::sortedZones(), Foam::writeHeader(), and Foam::writeZone().

Here is the call graph for this function:

◆ read()

bool read ( const fileName filename)
virtual

Read from file.

Reimplemented from MeshedSurface< Face >.

Definition at line 50 of file AC3DsurfaceFormat.C.

References DynamicList< T, SizeMin >::append(), args, clear(), Foam::endl(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, forAll, ISstream::getLine(), IOstream::good(), Foam::name(), nZones, validate(), Foam::foamVersion::version, WarningInFunction, Vector< Cmpt >::x(), Vector< Cmpt >::y(), Vector< Cmpt >::z(), and Foam::Zero.

Here is the call graph for this function:

◆ write() [3/3]

virtual void write ( const fileName name,
const dictionary options 
) const
inlinevirtual

Write surface mesh to file.

Reimplemented from MeshedSurface< Face >.

Definition at line 107 of file AC3DsurfaceFormat.H.

References Foam::name(), and AC3DsurfaceFormat< Face >::write().

Here is the call graph for this function:

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