FieldBase Class Reference

Template invariant parts for Field and SubField. More...

#include <Field.H>

Inheritance diagram for FieldBase:

Collaboration diagram for FieldBase:

Public Member Functions
constexpr	FieldBase () noexcept
	Default construct.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Static Public Member Functions
static void	warnLocalBoundaryConsistencyCompat (const dictionary &)
	Warn about keyword changes for local boundary consistency checks.
static int	localBoundaryConsistency () noexcept
	Get flag for local boundary consistency checks.
static int	localBoundaryConsistency (int val) noexcept
	Set flag for local boundary consistency checks.

Static Public Attributes
static const char *const	typeName
	Typename for Field.
static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size.
static bool	unifiedGeometricField
	GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField".
static int	localBoundaryConsistency_
	Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency".
static scalar	localBoundaryTolerance_
	Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance".

Detailed Description

Template invariant parts for Field and SubField.

Definition at line 82 of file Field.H.

Constructor & Destructor Documentation

FieldBase()

FieldBase ( )

inlineconstexprnoexcept

Default construct.

Definition at line 156 of file Field.H.

References Foam::noexcept, and refCount::refCount().

Here is the call graph for this function:

Member Function Documentation

warnLocalBoundaryConsistencyCompat()

void warnLocalBoundaryConsistencyCompat ( const dictionary & dict )

static

Warn about keyword changes for local boundary consistency checks.

The supplied dictionary corresponds to the optimisationSwitches

Definition at line 76 of file FieldBase.C.

References dict, e, error::master(), Foam::nl, and error::warnAboutAge().

Referenced by argList::parse(), and Time::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

localBoundaryConsistency() [1/2]

int localBoundaryConsistency ( )

inlinestaticnoexcept

Get flag for local boundary consistency checks.

Definition at line 133 of file Field.H.

References localBoundaryConsistency_, and Foam::noexcept.

Referenced by cyclicACMIFvPatchField< Type >::cyclicACMIFvPatchField(), cyclicAMIFvPatchField< Type >::cyclicAMIFvPatchField(), GeometricBoundaryField< Type, PatchField, GeoMesh >::evaluateLocal(), setFlow::execute(), cyclicAMIFvPatchField< scalar >::rmap(), and SRFModel::U().

Here is the caller graph for this function:

localBoundaryConsistency() [2/2]

int localBoundaryConsistency ( int val )

inlinestaticnoexcept

Set flag for local boundary consistency checks.

Returns

the previous value

Definition at line 143 of file Field.H.

References localBoundaryConsistency_.

Member Data Documentation

typeName

const char *const typeName

static

Typename for Field.

Definition at line 93 of file Field.H.

Referenced by Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable(), fvMotionSolver::cellMotionBoundaryTypes(), motionSmootherAlgo::curPoints(), fvMeshDistribute::distribute(), parseDriver::getField(), basicThermo::heBoundaryTypes(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), singleLayerRegion::mappedPushedFieldPatchTypes(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), parseDriver::patchNormalField(), patchDistMethod::patchTypes(), parseDriver::setResult(), parseDriver::setResult(), parseDriver::setResult(), ThermoPhaseModel< BasePhaseModel, ThermoType >::ThermoPhaseModel(), IOFieldRef< Type >::type(), Sample< Type >::value(), CompactIOField< T >::writeObject(), writer::writeSolution(), and foamWriter::writeTemplate().

allowConstructFromLargerSize

bool allowConstructFromLargerSize = false

static

Permit read construct from a larger size.

Mostly required for things like column mesh, for example.

Definition at line 100 of file Field.H.

Referenced by Field< Type >::assign(), if(), dynamicFvMesh::New(), and points0MotionSolver::points0MotionSolver().

unifiedGeometricField

bool unifiedGeometricField

static

GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField".

Definition at line 106 of file Field.H.

Referenced by GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and registerOptSwitch().

localBoundaryConsistency_

int localBoundaryConsistency_

static

Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency".

Definition at line 112 of file Field.H.

Referenced by localBoundaryConsistency(), localBoundaryConsistency(), and registerOptSwitch().

localBoundaryTolerance_

Foam::scalar localBoundaryTolerance_

static

Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance".

Definition at line 118 of file Field.H.

Referenced by registerOptSwitch().

---

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

• src/OpenFOAM/fields/Fields/Field/Field.H
• src/OpenFOAM/fields/Fields/Field/FieldBase.C