write Class Reference

A zoneGenerator which writes all existing zones from the mesh. More...

Inheritance diagram for write:
Collaboration diagram for write:

Public Member Functions

 TypeName ("write")
 Runtime type information. More...
 
 write (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~write ()
 Destructor. More...
 
virtual zoneSet generate () const
 Generate and return the zoneSet. More...
 
- Public Member Functions inherited from zoneGenerator
 TypeName ("zoneGenerator")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, zoneGenerator, dictionary,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))
 
 zoneGenerator (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from name, polyMesh and dictionary. More...
 
 zoneGenerator (const zoneGenerator &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~zoneGenerator ()
 Destructor. More...
 
const wordname () const
 
const wordzoneName () const
 
bool moveUpdate () const
 Return true if the zoneGenerator updates any of the zones. More...
 
virtual zoneSet movePoints () const
 Regenerate the zoneSet following mesh point motion. More...
 
void operator= (const zoneGenerator &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from zoneGenerator
static autoPtr< zoneGeneratorNew (const word &name, const polyMesh &mesh, const dictionary &dict)
 Select constructed from name, mesh and dictionary. More...
 
static autoPtr< zoneGeneratorNew (const word &name, const zoneTypes &zoneType, const polyMesh &mesh, const dictionary &dict)
 Select constructed from name, zoneType, mesh and dictionary. More...
 
static autoPtr< zoneGeneratorNew (const polyMesh &mesh, const dictionary &dict)
 Select constructed from mesh and first valid dictionary. More...
 
static labelList indices (const boolList &selected)
 Return the list of selected indices. More...
 
- Protected Attributes inherited from zoneGenerator
const word name_
 Name of zone generator. More...
 
const dictionary dict_
 Dictionary cached for error context. More...
 
const word zoneName_
 Name of the zone (defaults to the name of the generator) More...
 
const polyMeshmesh_
 Reference to the polyMesh. More...
 
bool moveUpdate_
 Switch to update the zones if the mesh points are moved. More...
 

Detailed Description

A zoneGenerator which writes all existing zones from the mesh.

Usage
Property Description Required Default value
type Type: write yes
zoneType Type of zone no all the zone types

Examples: To write all the zones that are changing:

        writeAllZones
        {
            type        write;
        }

or to write only the cellZones:

        writeCellZones
        {
            type        write;
            zoneType    cell;
        }

When called from the top-level of the createZonesDict or zonesGenerator files which is the most likely use the simpler syntax to write all the zones that are changing can be used:

        write;

or to write only the cellZones:

        write
        {
            zoneType    cell;
        }
See also
zoneGenerators::remove zoneGenerators::clear
Source files

Definition at line 106 of file write.H.

Constructor & Destructor Documentation

◆ write()

write ( const word name,
const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 68 of file write.C.

References Foam::all, dict, and zoneGenerator::moveUpdate_.

◆ ~write()

~write ( )
virtual

Destructor.

Definition at line 88 of file write.C.

Member Function Documentation

◆ TypeName()

TypeName ( "write"  )

Runtime type information.

◆ generate()

Foam::zoneSet generate ( ) const
virtual

Generate and return the zoneSet.

Implements zoneGenerator.

Definition at line 94 of file write.C.

References Foam::all, Foam::cell, Foam::face, and Foam::point.


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