Variant of wallDist that uses meshWave and stores the addressing. More...

Inheritance diagram for wallDistAddressing:

Collaboration diagram for wallDistAddressing:

[legend]

Public Member Functions
	ClassName ("wallDistAddressing")

	wallDistAddressing (const fvMesh &mesh, const bool correctWalls=true, const label updateInterval=1)
	Construct from mesh and near-wall behaviour. More...

	wallDistAddressing (const word &patchTypeName, const fvMesh &mesh, const labelList &patchIDs, const bool correctWalls=true, const label updateInterval=1)
	Construct from patch type name (= registration name), mesh and patch IDs. More...

virtual	~wallDistAddressing ()
	Destructor. More...

const labelUList &	patchIDs () const noexcept
	Return the patchIDs. More...

const volScalarField &	y () const noexcept
	Return reference to cached distance-to-wall field. Unvisited. More...

virtual bool	movePoints ()
	Update the y-field when the mesh moves. More...

virtual void	updateMesh (const mapPolyMesh &)
	Update the y-field when the mesh changes. More...

template<class Container , class Type >
tmp< Field< Type > >	collectPatchFields (const Container &bfld) const
	Collect patchFields from patchIDs into straight list. More...

template<class VolField >
void	extract (const Field< typename VolField::value_type > &patchFld, VolField &fld) const
	Take collected/distributed patch field and fill volField. More...

template<class VolField , class TransformOp >
const VolField &	map (VolField &fld, const TransformOp &top=mapDistribute::transform()) const
	Map nearest-patch information. Take wall patch values. More...

template<class Container , class Type >
Foam::tmp< Foam::Field< Type > >	collectPatchFields (const Container &bfld) const

Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDistAddressing >
	MeshObject (const fvMesh &mesh)
	Construct with Type::typeName on Mesh. More...

	MeshObject (const word &objName, const fvMesh &mesh)
	Construct with given object name on Mesh. More...

virtual	~MeshObject ()=default
	Destructor. More...

const fvMesh &	mesh () const noexcept
	Reference to the mesh. More...

virtual bool	writeData (Ostream &os) const
	Dummy write. More...

Public Member Functions inherited from UpdateableMeshObject< fvMesh >
	UpdateableMeshObject (const word &objName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from MoveableMeshObject< fvMesh >
	MoveableMeshObject (const word &objName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from GeometricMeshObject< fvMesh >
	GeometricMeshObject (const word &objName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from TopologicalMeshObject< fvMesh >
	TopologicalMeshObject (const word &objName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from meshObject
	ClassName ("meshObject")
	Runtime declaration and debug switch. More...

	meshObject (const word &objName, const objectRegistry &obr)
	Construct with given object name on a registry. More...

Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment. More...

	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...

bool	ownedByRegistry () const noexcept
	Is this object owned by the registry? More...

bool	store ()
	Register object with its registry and transfer ownership to the registry. More...

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

label	eventNo () const noexcept
	Event number at last update. More...

label &	eventNo () noexcept
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...

Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options. More...

virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB. More...

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options. More...

	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...

const Time &	time () const noexcept
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object name. More...

const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

const string &	note () const noexcept
	Return the optional note. More...

string &	note () noexcept
	Modifiable access to the optional note. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

template<class Type >
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName. More...

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const noexcept
	Return the Time::rootPath() More...

const fileName &	caseName () const noexcept
	Return the Time::caseName() More...

const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

fileName	path () const
	The complete path for the object (with instance, local,...). More...

fileName	globalPath () const
	The complete global path for the object (with instance, local,...) More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	globalObjectPath () const
	The complete global path + object name. More...

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...

bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...

bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. More...

template<class Type >
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format. More...

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format. More...

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

template<>
bool	isHeaderClass () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

template<class Type >
Foam::fileName	typeFilePath (const bool search) const

Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...

constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options. More...

constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options. More...

constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option. More...

constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool. More...

constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool. More...

readOption	readOpt () const noexcept
	Get the read option. More...

readOption	readOpt (readOption opt) noexcept
	Set the read option. More...

writeOption	writeOpt () const noexcept
	Get the write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Set the write option. More...

bool	registerObject () const noexcept
	Should objects created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference. More...

bool	globalObject () const noexcept
	True if object is treated the same for all processors. More...

bool	globalObject (bool on) noexcept
	Change global-object status. More...

bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ) More...

bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set. More...

bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

Public Member Functions inherited from cellDistFuncs
	ClassName ("cellDistFuncs")

	cellDistFuncs (const polyMesh &mesh)
	Construct from mesh. More...

const polyMesh &	mesh () const
	Access mesh. More...

labelHashSet	getPatchIDs (const UList< wordRe > &patchNames) const
	Return the set of patch IDs corresponding to the given names. More...

template<class Type >
labelHashSet	getPatchIDs () const
	Get patchIDs of/derived off certain type (e.g. 'processorPolyPatch') More...

scalar	smallestDist (const point &p, const polyPatch &patch, const labelUList &wallFaces, label &meshFacei) const
	Calculate smallest true distance (and face index) More...

void	getPointNeighbours (const primitivePatch &, const label patchFacei, DynamicList< label > &) const
	Get faces sharing point with face on patch. More...

label	maxPatchSize (const labelHashSet &patchIDs) const
	Size of largest patch (out of supplied subset of patches) More...

label	sumPatchSize (const labelHashSet &patchIDs) const
	Sum of patch sizes (out of supplied subset of patches). More...

void	correctBoundaryFaceCells (const labelHashSet &patchIDs, scalarField &wallDistCorrected, Map< label > &nearestFace) const
	Correct all cells connected to boundary (via face). Sets values in. More...

void	correctBoundaryPointCells (const labelHashSet &patchIDs, scalarField &wallDistCorrected, Map< label > &nearestFace) const
	Correct all cells connected to wall (via point). Sets values in. More...

template<class Type >
Foam::labelHashSet	getPatchIDs () const

Protected Member Functions
label	getValues (const FaceCellWave< wallPointAddressing > &wave, const List< wallPointAddressing > &allCellInfo, const List< wallPointAddressing > &allFaceInfo, volScalarField &y) const
	Extract FaceCellWave data. More...

void	addItem (const label item, const labelPair &data, label &untransformi, label &transformi, labelPairList &transformedWallInfo)
	Store nearest-data to cell or boundary face. More...

void	correct (volScalarField &y)
	Extract nearest-patch distance data. More...

	wallDistAddressing (const wallDistAddressing &)=delete
	No copy construct. More...

void	operator= (const wallDistAddressing &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Protected Attributes
const labelList	patchIDs_
	Set of patch IDs. More...

const word	patchTypeName_
	Name for the patch set, e.g. "wall". More...

const label	updateInterval_
	Update wall distance every updateInterval_ steps. More...

const bool	correctWalls_
	Do accurate distance calculation for near-wall cells. More...

bool	requireUpdate_
	Flag to indicate whether the wall distance requires updating. More...

volScalarField	y_
	Distance-to-wall field. More...

autoPtr< globalIndex >	globalWallsPtr_
	Number of wall faces. More...

autoPtr< mapDistribute >	mapPtr_
	Map to pull wall face info to cell or boundary face. More...

labelList	untransformedItems_
	Indices of cells followed by boundary faces. More...

labelList	untransformedSlots_
	Corresponding slot in mapPtr distribution result. More...

labelList	untransformedPatchStarts_
	Start of patches. Start of untransformedPatchStarts_[0] is end. More...

labelList	transformedItems_

labelList	transformedSlots_

labelList	transformedPatchStarts_

Protected Attributes inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDistAddressing >
const fvMesh &	mesh_
	Reference to the mesh. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from IOobjectOption
enum	readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...

enum	writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...

enum	registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true) More...

Static Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDistAddressing >
static const wallDistAddressing &	New (const fvMesh &mesh, Args &&... args)
	Get existing or create a new MeshObject. Registered with typeName. More...

static const wallDistAddressing &	New (const word &objName, const fvMesh &mesh, Args &&... args)
	Get existing or create a new MeshObject using supplied registration name. More...

static bool	Delete (const word &objName, const fvMesh &mesh)
	Static destructor using supplied registration name. More...

static bool	Delete (const fvMesh &mesh)
	Static destructor using Type::typeName. More...

Static Public Member Functions inherited from meshObject
template<class Mesh >
static void	movePoints (objectRegistry &obr)

template<class Mesh >
static void	updateMesh (objectRegistry &obr, const mapPolyMesh &mpm)

template<class Mesh , template< class > class MeshObjectType>
static void	clear (objectRegistry &obr)

template<class Mesh , template< class > class FromType, template< class > class ToType>
static void	clearUpto (objectRegistry &obr)
	Clear all meshObject derived from FromType up to (but not including) ToType. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ) More...

static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set. More...

static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...

static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information. More...

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Variant of wallDist that uses meshWave and stores the addressing.

Can be used to transport other wall properties. For example getting the nearest-wall normal into a volVectorField

    // If not yet constructed construct from all wall patches
    const auto& wDist = wallDistAddressing::New(mesh);

    // Fill boundaryField with normal
    for (const label patchi : wDist.patchIDs())
    {
        auto& pnf = n.boundaryFieldRef()[patchi];
        pnf == pnf.patch().nf();
    }

    // Map data from nearest wall (using transformation if nearest is
    // reached through a coupled patch with transformation)
    wDist.map(n, mapDistribute::transform());

Another use is e.g. to get the distance to cyclic patches. This enforces registration under the supplied name.

    // If not yet constructed construct from selected patches
    const labelList& patchIDs = ..

    const auto& wDist = wallDistAddressing::New
    (
        "myPatches",    // registration name
        mesh,
        patchIDs
    );

    // Fill boundaryField with normal
    for (const label patchi : wDist.patchIDs())
    {
        auto& pnf = n.boundaryFieldRef()[patchi];
        pnf == pnf.patch().nf();
    }

    // Map data from nearest patch face (using transformation if nearest is
    // reached through a coupled patch with transformation)
    wDist.map(n, mapDistribute::transform());

Note: By default (correctWalls = true) all cells point-connected to a wall explicitly search for the nearest location on the point-surrouding wall faces (so override the wave behaviour). This gets only done for processor-local wall faces.

See also: Foam::wallDist

Source files

Definition at line 107 of file wallDistAddressing.H.

Constructor & Destructor Documentation

◆ wallDistAddressing() [1/3]

wallDistAddressing ( const wallDistAddressing & )

protecteddelete

No copy construct.

◆ wallDistAddressing() [2/3]

wallDistAddressing	(	const fvMesh &	mesh,
		const bool	correctWalls = `true`,
		const label	updateInterval = `1`
	)

explicit

Construct from mesh and near-wall behaviour.

Definition at line 376 of file wallDistAddressing.C.

◆ wallDistAddressing() [3/3]

wallDistAddressing	(	const word &	patchTypeName,
		const fvMesh &	mesh,
		const labelList &	patchIDs,
		const bool	correctWalls = `true`,
		const label	updateInterval = `1`
	)

Construct from patch type name (= registration name), mesh and patch IDs.

Definition at line 408 of file wallDistAddressing.C.

◆ ~wallDistAddressing()

~wallDistAddressing ( )

virtual

Destructor.

Definition at line 446 of file wallDistAddressing.C.

Member Function Documentation

◆ getValues()

Foam::label getValues	(	const FaceCellWave< wallPointAddressing > &	wave,
		const List< wallPointAddressing > &	allCellInfo,
		const List< wallPointAddressing > &	allFaceInfo,
		volScalarField &	y
	)		const

protected

Extract FaceCellWave data.

Definition at line 41 of file wallDistAddressing.C.

References FaceCellWave< Type, TrackingData >::data(), forAll, Foam::sqrt(), y, and Foam::Zero.

Referenced by wallDistAddressing::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addItem()

void addItem	(	const label	item,
		const labelPair &	data,
		label &	untransformi,
		label &	transformi,
		labelPairList &	transformedWallInfo
	)

protected

Store nearest-data to cell or boundary face.

Definition at line 98 of file wallDistAddressing.C.

Referenced by wallDistAddressing::correct().

Here is the caller graph for this function:

◆ correct()

void correct ( volScalarField & y )

protected

Extract nearest-patch distance data.

Definition at line 126 of file wallDistAddressing.C.

Here is the call graph for this function:

◆ operator=()

void operator= ( const wallDistAddressing & )

protecteddelete

No copy assignment.

◆ ClassName()

ClassName ( "wallDistAddressing" )

◆ patchIDs()

const labelUList& patchIDs ( ) const

inlinenoexcept

Return the patchIDs.

Definition at line 269 of file wallDistAddressing.H.

References wallDistAddressing::patchIDs_.

◆ y()

const volScalarField& y ( ) const

inlinenoexcept

Return reference to cached distance-to-wall field. Unvisited.

elements set to GREAT

Definition at line 279 of file wallDistAddressing.H.

References wallDistAddressing::y_.

Referenced by wallDistAddressing::correct().

Here is the caller graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

Update the y-field when the mesh moves.

Implements MoveableMeshObject< fvMesh >.

Definition at line 452 of file wallDistAddressing.C.

References correct, DebugInfo, and Foam::endl().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update the y-field when the mesh changes.

Implements UpdateableMeshObject< fvMesh >.

Definition at line 478 of file wallDistAddressing.C.

◆ collectPatchFields() [1/2]

tmp<Field<Type> > collectPatchFields ( const Container & bfld ) const

Collect patchFields from patchIDs into straight list.

◆ extract()

void extract	(	const Field< typename VolField::value_type > &	patchFld,
		VolField &	fld
	)		const

Take collected/distributed patch field and fill volField.

Definition at line 53 of file wallDistAddressingTemplates.C.

References stdFoam::end(), fld, and forAll.

Here is the call graph for this function:

◆ map()

const VolField & map	(	VolField &	fld,
		const TransformOp &	top = `mapDistribute::transform()`
	)		const

Map nearest-patch information. Take wall patch values.

and transports these to the internal field and other patches. Use mapDistribute::transformPosition if transporting absolute coordinates.

Definition at line 124 of file wallDistAddressingTemplates.C.

References Foam::extract(), and fld.

Referenced by wallDistAddressing::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectPatchFields() [2/2]

Foam::tmp<Foam::Field<Type> > collectPatchFields ( const Container & bfld ) const

Definition at line 26 of file wallDistAddressingTemplates.C.

References n, and Foam::New().

Here is the call graph for this function:

Member Data Documentation

◆ patchIDs_

const labelList patchIDs_

protected

Set of patch IDs.

Definition at line 124 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct(), and wallDistAddressing::patchIDs().

◆ patchTypeName_

const word patchTypeName_

protected

Name for the patch set, e.g. "wall".

Definition at line 129 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ updateInterval_

const label updateInterval_

protected

Update wall distance every updateInterval_ steps.

Definition at line 134 of file wallDistAddressing.H.

◆ correctWalls_

const bool correctWalls_

protected

Do accurate distance calculation for near-wall cells.

Definition at line 139 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ requireUpdate_

bool requireUpdate_

protected

Flag to indicate whether the wall distance requires updating.

Definition at line 144 of file wallDistAddressing.H.

◆ y_

volScalarField y_

mutableprotected

Distance-to-wall field.

Definition at line 149 of file wallDistAddressing.H.

Referenced by wallDistAddressing::y().

◆ globalWallsPtr_

autoPtr<globalIndex> globalWallsPtr_

protected

Number of wall faces.

Definition at line 154 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ mapPtr_

autoPtr<mapDistribute> mapPtr_

protected

Map to pull wall face info to cell or boundary face.

Definition at line 159 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ untransformedItems_

labelList untransformedItems_

protected

Indices of cells followed by boundary faces.

Definition at line 164 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ untransformedSlots_

labelList untransformedSlots_

protected

Corresponding slot in mapPtr distribution result.

Definition at line 169 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ untransformedPatchStarts_

labelList untransformedPatchStarts_

protected

Start of patches. Start of untransformedPatchStarts_[0] is end.

of cell information

Definition at line 176 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ transformedItems_

labelList transformedItems_

protected

Definition at line 179 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ transformedSlots_

labelList transformedSlots_

protected

Definition at line 180 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

◆ transformedPatchStarts_

labelList transformedPatchStarts_

protected

Definition at line 181 of file wallDistAddressing.H.

Referenced by wallDistAddressing::correct().

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

src/finiteVolume/fvMesh/wallDist/wallDistAddressing/wallDistAddressing.H
src/finiteVolume/fvMesh/wallDist/wallDistAddressing/wallDistAddressing.C
src/finiteVolume/fvMesh/wallDist/wallDistAddressing/wallDistAddressingTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ wallDistAddressing() [1/3]

◆ wallDistAddressing() [2/3]

◆ wallDistAddressing() [3/3]

◆ ~wallDistAddressing()

Member Function Documentation

◆ getValues()

◆ addItem()

◆ correct()

◆ operator=()

◆ ClassName()

◆ patchIDs()

◆ y()

◆ movePoints()

◆ updateMesh()

◆ collectPatchFields() [1/2]

◆ extract()

◆ map()

◆ collectPatchFields() [2/2]

Member Data Documentation

◆ patchIDs_

◆ patchTypeName_

◆ updateInterval_

◆ correctWalls_

◆ requireUpdate_

◆ y_

◆ globalWallsPtr_

◆ mapPtr_

◆ untransformedItems_

◆ untransformedSlots_

◆ untransformedPatchStarts_

◆ transformedItems_

◆ transformedSlots_

◆ transformedPatchStarts_