print Class Reference

Print a summary of one or more zones to the terminal. More...

Inheritance diagram for print:
Collaboration diagram for print:

Public Member Functions

 TypeName ("print")
 Runtime type information. More...
 
 print (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~print ()
 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
 Return the zoneGenerator name. More...
 
const wordzoneName () const
 Return the zone name. More...
 
const polyMeshmesh () const
 Return reference to the polyMesh. More...
 
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

Print a summary of one or more zones to the terminal.

All zone types The number of elements (points, faces or cells) in the zone The bounding box containing the elements The bounding sphere containing the elements

pointZones The average position of all the points

faceZones The total face area magnitude The centroid of the faces

cellZones The total volume The centroid of the cells

Usage
Property Description Required Default value
type Type: print yes
zoneType Type of zone no all
zone Name of the zone to print no
zones List of zone names to print no
geometry Print the geometry? no true

Examples: Print a summary of a zone named 'fan'

        printOneZone
        {
            type        print;

            zone        fan;
        }

Print a summary of a zone named 'fan' and a zone named 'baffle'

        printTwoZones
        {
            type        print;

            zones
            (
                fan
                baffle
            );
        }

Print a summary of all the zones, by omitting 'zone' and 'zones'

        printAllZones
        {
            type        print;
        }

In createZonesDict, shorthand notation can be used to print all zones

        print;
Source files

Definition at line 144 of file print.H.

Constructor & Destructor Documentation

◆ print()

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

Construct from dictionary.

Definition at line 45 of file print.C.

References Foam::all.

◆ ~print()

~print ( )
virtual

Destructor.

Definition at line 76 of file print.C.

Member Function Documentation

◆ TypeName()

TypeName ( "print"  )

Runtime type information.

◆ generate()


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