A collection of tools for operating on an faMesh. More...

#include <faMeshTools.H>

Static Public Member Functions
static void	unregisterMesh (const faMesh &mesh)
	Unregister the faMesh from its associated polyMesh to prevent triggering on polyMesh changes etc.
static void	forceDemandDriven (faMesh &mesh)
	Force creation of everything that might vaguely be used by patches.
static autoPtr< faMesh >	newMesh (const word &areaName, const IOobject &io, const polyMesh &pMesh, const bool masterOnlyReading, const bool verbose=false)
	Read mesh or create dummy mesh (0 faces, >0 patches).
static autoPtr< faMesh >	newMesh (const IOobject &io, const polyMesh &pMesh, const bool masterOnlyReading, const bool verbose=false)
	Read mesh or create dummy mesh (0 faces, >0 patches).
static autoPtr< faMesh >	loadOrCreateMesh (const word &areaName, const IOobject &io, const polyMesh &pMesh, const bool decompose, const bool verbose=false)
static autoPtr< faMesh >	loadOrCreateMesh (const IOobject &io, const polyMesh &pMesh, const bool decompose, const bool verbose=false)
static autoPtr< faMesh >	loadOrCreateMesh (const word &areaName, const IOobject &io, const polyMesh &pMesh, refPtr< fileOperation > &readHandler, const bool verbose=false)
static autoPtr< faMesh >	loadOrCreateMesh (const IOobject &io, const polyMesh &pMesh, refPtr< fileOperation > &readHandler, const bool verbose=false)
static mapDistributePolyMesh	readProcAddressing (const faMesh &mesh, const faMesh *baseMeshPtr)
	Read decompose/reconstruct addressing.
static void	writeProcAddressing (const faMesh &mesh, const mapDistributePolyMesh &faDistMap, const bool decompose, refPtr< fileOperation > &writeHandler, const faMesh *procMesh=nullptr)
	Write decompose/reconstruct addressing.
template<class Type>
static tmp< Field< Type > >	flattenEdgeField (const GeometricField< Type, faePatchField, edgeMesh > &fld, const bool primitiveOrdering=false)
	Flatten an edge field into linear addressing.
static void	printMeshChecks (const faMesh &mesh, const int verbose=1)
	Report mesh information.
static mapDistributePolyMesh	readProcAddressing (const faMesh &procMesh, const autoPtr< faMesh > &baseMeshPtr)
	Read decompose/reconstruct addressing.

Detailed Description

A collection of tools for operating on an faMesh.

Source files

Definition at line 57 of file faMeshTools.H.

Member Function Documentation

◆ unregisterMesh()

void unregisterMesh ( const faMesh & mesh )

static

Unregister the faMesh from its associated polyMesh to prevent triggering on polyMesh changes etc.

References mesh.

◆ forceDemandDriven()

void forceDemandDriven ( faMesh & mesh )

static

Force creation of everything that might vaguely be used by patches.

This is fairly horrible.

References mesh.

◆ newMesh() [1/2]

autoPtr< faMesh > newMesh	(	const word &	areaName,
		const IOobject &	io,
		const polyMesh &	pMesh,
		const bool	masterOnlyReading,
		const bool	verbose = false )

static

Read mesh or create dummy mesh (0 faces, >0 patches).

Works in two modes according to masterOnlyReading: true : create a dummy mesh for all procs false: checks locally for mesh directories and only creates dummy mesh if not present

Parameters

areaName	The area region
io	The IOobject describes the base polyMesh

References io.

Referenced by newMesh().

Here is the caller graph for this function:

◆ newMesh() [2/2]

autoPtr< faMesh > newMesh	(	const IOobject &	io,
		const polyMesh &	pMesh,
		const bool	masterOnlyReading,
		const bool	verbose = false )

inlinestatic

Read mesh or create dummy mesh (0 faces, >0 patches).

Works in two modes according to masterOnlyReading: true : create a dummy mesh for all procs false: checks locally for mesh directories and only creates dummy mesh if not present

Parameters

io	The IOobject describes the base polyMesh

Definition at line 122 of file faMeshTools.H.

References io, newMesh(), and word::null.

Here is the call graph for this function:

◆ loadOrCreateMesh() [1/4]

autoPtr< faMesh > loadOrCreateMesh	(	const word &	areaName,
		const IOobject &	io,
		const polyMesh &	pMesh,
		const bool	decompose,
		const bool	verbose = false )

static

Parameters

areaName	The area region
io	The IOobject describes the base polyMesh

References io.

Referenced by loadOrCreateMesh(), and loadOrCreateMesh().

Here is the caller graph for this function:

◆ loadOrCreateMesh() [2/4]

autoPtr< faMesh > loadOrCreateMesh	(	const IOobject &	io,
		const polyMesh &	pMesh,
		const bool	decompose,
		const bool	verbose = false )

inlinestatic

Parameters

io	The IOobject describes the base polyMesh

Definition at line 160 of file faMeshTools.H.

References io, loadOrCreateMesh(), and word::null.

Here is the call graph for this function:

◆ loadOrCreateMesh() [3/4]

autoPtr< faMesh > loadOrCreateMesh	(	const word &	areaName,
		const IOobject &	io,
		const polyMesh &	pMesh,
		refPtr< fileOperation > &	readHandler,
		const bool	verbose = false )

static

Parameters

areaName	The area region
io	The IOobject describes the base polyMesh
readHandler	Non-null reference if a mesh exists on given processor

References io.

◆ loadOrCreateMesh() [4/4]

autoPtr< faMesh > loadOrCreateMesh	(	const IOobject &	io,
		const polyMesh &	pMesh,
		refPtr< fileOperation > &	readHandler,
		const bool	verbose = false )

inlinestatic

Parameters

io	The IOobject describes the base polyMesh
readHandler	Non-null reference if a mesh exists on given processor

Definition at line 199 of file faMeshTools.H.

References io, loadOrCreateMesh(), and word::null.

Here is the call graph for this function:

◆ readProcAddressing() [1/2]

mapDistributePolyMesh readProcAddressing	(	const faMesh &	mesh,
		const faMesh *	baseMeshPtr )

static

Read decompose/reconstruct addressing.

References mesh.

◆ writeProcAddressing()

void writeProcAddressing	(	const faMesh &	mesh,
		const mapDistributePolyMesh &	faDistMap,
		const bool	decompose,
		refPtr< fileOperation > &	writeHandler,
		const faMesh *	procMesh = nullptr )

static

Write decompose/reconstruct addressing.

Note: Since the faMesh holds a reference to a polyMesh, in reconstruct mode it will refer to the base mesh, but we need a means to proc addressing into the processor locations. This is the purpose of the additional procMesh reference

Parameters

decompose	running in decompose vs reconstruct mode
writeHandler	The output file handler
procMesh	optional processor mesh in reconstruct mode

References mesh.

◆ flattenEdgeField()

template<class Type>

tmp< Field< Type > > flattenEdgeField	(	const GeometricField< Type, faePatchField, edgeMesh > &	fld,
		const bool	primitiveOrdering = false )

static

Flatten an edge field into linear addressing.

Optionally use primitive patch edge ordering

References fld().

Here is the call graph for this function:

◆ printMeshChecks()

void printMeshChecks	(	const faMesh &	mesh,
		const int	verbose = 1 )

static

Report mesh information.

References mesh.

◆ readProcAddressing() [2/2]

mapDistributePolyMesh readProcAddressing	(	const faMesh &	procMesh,
		const autoPtr< faMesh > &	baseMeshPtr )

static

Read decompose/reconstruct addressing.

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

src/finiteArea/faMesh/faMeshTools/faMeshTools.H

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ unregisterMesh()

◆ forceDemandDriven()

◆ newMesh() [1/2]

◆ newMesh() [2/2]

◆ loadOrCreateMesh() [1/4]

◆ loadOrCreateMesh() [2/4]

◆ loadOrCreateMesh() [3/4]

◆ loadOrCreateMesh() [4/4]

◆ readProcAddressing() [1/2]

◆ writeProcAddressing()

◆ flattenEdgeField()

◆ printMeshChecks()

◆ readProcAddressing() [2/2]