N CGAL Specializations for CGAL-related routines C indexedCell An indexed form of CGAL::Triangulation_cell_base_3<K> used to keep track of the Delaunay cells (tets) in the tessellation C Rebind_TDS C indexedVertex An indexed form of CGAL::Triangulation_vertex_base_3<K> used to keep track of the Delaunay vertices in the tessellation C Rebind_TDS C indexedFace An indexed form of CGAL::Triangulation_face_base_2<K> used to keep track of the vertices in the triangulation C Rebind_TDS N Foam Namespace for OpenFOAM N functionObjects Function objects are OpenFOAM utilities to ease workflow configurations and enhance workflows N fieldValues C volFieldValue Provides a 'volRegion ' specialization of the fieldValue C multiFieldValue Computes a selected operation between multiple function objects N runTimeControls C averageCondition Average run time condition - satisfied when average does not change by more than a given value C equationInitialResidualCondition Minimum or maximum initial residual run time condition C equationMaxIterCondition Maximum number of equation iterations run time condition C maxDurationCondition Activated after a user-specified duration C minMaxCondition C minTimeStepCondition Minimum time step condition C noneCondition C runTimeCondition Base class for run time conditions C runTimeControl C ObukhovLength Computes the Obukhov length field and associated friction velocity field C writeFreeSurface A function object to write the control points on the free surface C fieldInfo Helper class to store a wordRe and label used by Foam::functionObjects::fieldSelection C fieldSelection Helper class to manage field selections C fileFieldSelection Helper class to manage file-based field selections C solverFieldSelection C volFieldSelection Helper class to manage solver field selections C fvMeshFunctionObject Specialization of Foam::functionObject for an Foam::fvMesh , providing a reference to the Foam::fvMesh C volRegion Volume (cell) region selection class C add Sums a given list of (at least two or more) fields and outputs the result into a new field. All input fields must have matching sizes and compatible dimensions; otherwise, an error will be raised C age Calculates and writes out the time taken for a particle to travel from an inlet to the location. Solves the following equation when incompressible: C AMIWeights Computes the min/max/average weights of arbitrary mesh interface (AMI) patches, and optionally reports to a text file or writes VTK surfaces of the sum of the weights and mask fields for arbitrarily coupled mesh interface (ACMI) patches C binField Calculates binned data, where specified patches are divided into segments according to various input bin characteristics, so that spatially-localised information can be output for each segment C blendingFactor Computes blending factor as an indicator about which of the schemes is active across the domain C cellDecomposer Maps input fields from local mesh to a secondary mesh at runtime C columnAverage Computes the arithmetic average of given quantities along columns of cells in a given direction for structured-like layered meshes. It is, for example, useful for channel-like cases where spanwise average of a field is desired. However, the columnAverage C comfort Calculates the thermal comfort quantities predicted mean vote (PMV), predicted percentage of dissatisfaction (PPD) and the draught rate (DR) based on DIN ISO EN 7730:2005 C components Extracts the components of elements of a field and outputs the result into new fields, where the fields possess the same sizes and dimensions C continuityError Computes local, global and cumulative continuity errors for a flux field C CourantNo Computes the Courant number field for time-variant simulations C Curle Computes the acoustic pressure based on Curle 's analogy C ddt Computes the Eulerian time derivative of an input volume field for time-variant simulations (not appropriate to steady-state simulations) C ddt2 Computes the magnitude or magnitude squared of the Eulerian time derivative of an input volume field for time-variant simulations (not appropriate to steady-state simulations) C derivedFields Computes two predefined derived fields, i.e. rhoU, and pTotal, where the defined fields are hard-coded as follows: C DESModelRegions Computes an indicator field for detached eddy simulation (DES) turbulence calculations, where the values of the indicator mean: C div Computes the divergence of an input field C DMD Computes a dynamic mode decomposition model on a specified field C enstrophy Computes the enstrophy of an input volVectorField C fvExpressionField Function object that generates or modifies a field based on expressions C externalCoupled Provides a simple file-based communication interface for explicit coupling with an external application, so that data is transferred to- and from OpenFOAM. The data exchange employs specialised boundary conditions to provide either one-way or two-way coupling models C eulerianParticle C sumParticleOp C extractEulerianParticles Generates particle size information from Eulerian calculations, e.g. VoF C fieldAverage Computes ensemble- and/or time-based field averages, with optional windowing, for a user-specified selection of volumetric and/or surface fields C fieldAverageItem Helper class to describe what form of averaging to apply. A set will be applied to each base field in Foam::fieldAverage, of the following form C fieldExpression Intermediate class for handling field expression function objects (e.g. blendingFactor C fieldExtents Computes the spatial minimum and maximum extents of an input field C fieldMinMax Computes the values and locations of field minima and maxima. These are good indicators of calculation performance, e.g. to confirm that predicted results are within expected bounds, or how well a case is converging C fieldsExpression Intermediate class for handling field expression function objects (e.g. add, subtract etc.) whereinto more than one fields are input C fieldStatistics Calculates various statistics of the specified fields C fieldValue Intermediate class for handling field value-based function objects C flowType Computes the flow type indicator of an input velocity field C flux Computes the flux of an input vector field C fluxSummary Computes the volumetric- or mass-flux information across selections of face zones C grad Computes the gradient of an input field C heatTransferCoeff Computes the heat transfer coefficient [W/(m^2 K )] as a volScalarField C multiphaseInterHtcModel A heat transfer coefficient for multiphase inter solvers (e.g. icoReactingMultiphaseFoam) C reactingEulerHtcModel A heat transfer coefficient for reactingEuler solvers C histogram Computes the volume-weighted histogram of an input volScalarField C interfaceHeight This function object reports the height of the interface above a set of locations C Lambda2 Computes the second largest eigenvalue of the sum of the square of the symmetrical and anti-symmetrical parts of the velocity gradient tensor C LambVector Computes Lamb vector, i.e. the cross product of vorticity and velocity. Calculation of the divergence of the Lamb vector can be performed by using div function object on this LambVector C limitFields Limits input fields to user-specified min and max bounds C log Computes the natural logarithm of an input volScalarField C MachNo Computes the Mach number as a volScalarField C mag Computes the magnitude of an input field C magSqr Computes the magnitude of the square of an input field C mapFields Maps input fields from local mesh to secondary mesh at runtime C momentum Computes linear/angular momentum, reporting integral values and optionally writing the fields C momentumError Computes balance terms for the steady momentum equation C multiply Multiplies a given list of (at least two or more) fields and outputs the result into a new field C nearWallFields Samples near-patch volume fields within an input distance range C norm Normalises an input field with a chosen norm, and outputs a new normalised field C particleDistribution Generates a particle distribution for lagrangian data at a given time C PecletNo Computes the Peclet number as a surfaceScalarField C pow Computes the power of an input volScalarField C pressure Provides several methods to convert an input pressure field into derived forms, including: C processorField Writes a scalar field whose value is the local processor ID. The output field name is processorID C proudmanAcousticPower Computes the acoustic power due to the volume of isotropic turbulence using Proudman's formula C Q Computes the second invariant of the velocity gradient tensor C randomise Adds a random component to an input field, with a specified perturbation magnitude C reactionsSensitivityAnalysis Computes indicators for reaction rates of creation or destruction of species in each reaction C readFields Reads fields from the time directories and adds them to the mesh database for further post-processing C reference Computes a field whose values are offset to a reference value obtained by from a Function1 C regionSizeDistribution Creates a droplet size distribution via interrogating a continuous phase fraction field C resolutionIndex Computes a single-mesh resolution index according to the specified model, which is used as a LES/DES quality/post-verification metric that does not require any experimental or DNS data C setFlow Provides options to set the velocity and flux fields as a function of time C stabilityBlendingFactor Computes the stabilityBlendingFactor C streamFunction Computes the stream function (i.e. https://w.wiki/Ncm ) C streamLine Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field C streamLineBase C subtract Subtracts a given list of (at least one or more) fields from a field and produces a new field, where the fields possess the same sizes and dimensions C surfaceDistance Computes the distance to the nearest surface from a given geometry C surfaceInterpolate Linearly interpolates volume fields to generate surface fields C turbulenceFields Computes various turbulence-related quantities that are not typically output during calculations, and stores/writes them on the mesh database for further manipulation C valueAverage Computes the ensemble- or time-based singular-value average values, with optional windowing, from the output of function objects that generate non-field type values (e.g. Cd of forceCoeffs momentum_x in momentum function objects) C vorticity Computes the vorticity, the curl of the velocity C wallBoundedStreamLine Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field, constrained to a patch C wallHeatFlux This function object calculates the wall heat flux based on a custom model defined in the dictionary. The model can be specified to compute the heat flux according to user-defined criteria or equations C wallShearStress Computes the wall-shear stress at selected wall patches C writeCellCentres Writes the cell-centres volVectorField and the three component fields as volScalarFields C writeCellVolumes Writes the cell-volumes volScalarField C XiReactionRate Writes the turbulent flame-speed and reaction-rate volScalarFields for the Xi-based combustion models C yPlus Computes the near wall C zeroGradient Creates a volume field with zero-gradient boundary conditions from another volume field C bladeForces Computes forces and coefficients over a given list of patches by integrating pressure and viscous forces and moments C forceCoeffs Computes force and moment coefficients over a given list of patches, and optionally over given porous zones. The following coefficients can be selected and output: C forceComponents C coeffDesc Coefficients description C forces Computes forces and moments over a given list of patches by integrating pressure and viscous forces and moments, and optionally resistance forces and moments from porous zones C propellerInfo Calculates propeller performance and wake field properties C hydrostaticPressure Calculates and outputs the pressure fields p_rgh and ph_rgh C cloudInfo Outputs Lagrangian cloud information to a file C dataCloud This functionObject writes cloud positions in ASCII C dsmcFields This function object calculates and outputs the intensive fields: C ensightCloudWriteObject This functionObject writes cloud(s) in ensight format C icoUncoupledKinematicCloud This functionObject tracks a uncoupled kinematic particle cloud in the specified velocity field of an incompressible flow (laminar, RANS or LES) C vtkCloud This functionObject writes cloud(s) in VTK PolyData format (.vtp extension) with the time information saved in a '.series' file C sizeDistribution This function object calculates and outputs information about the size distribution of the dispersed phase, such as the number density function or its moments. It is designed to be used exclusively with the population balance modeling functionality of the reactingEulerFoam solvers. It can be applied to a specific cellZone or the entire domain C energySpectrum Calculates the energy spectrum for a structured IJK mesh C electricPotential Computes the steady-state equation of charge conservation to obtain the electric potential by strictly assuming a quasi-static electrostatic field for single-phase and multiphase applications C energyTransport Computes the simplified energy transport equation in single-phase or two-phase flow, considering incompressible cases: C scalarTransport Computes the transport equation for a passive scalar in single-phase or two-phase flow, considering both incompressible and compressible cases: C abort Watches for presence of the named trigger file in the case directory and signals a simulation stop (or other) event if found C caseInfo Collects and writes case information to file C codedFunctionObject Provides a general interface to enable dynamic code compilation C ensightWrite Writes fields in ensight format C foamReport Replaces user-supplied keywords by run-time computed values in a text file C graphFunctionObject Accumulates function object result values and renders into a graph in SVG format C multiRegion Wrapper that clones the supplied function object for each region C parProfiling Simple (simplistic) mpi-profiling C radiometerProbes Probes the incident radiative heat flux, qin, at arbitrary points within a domain C removeRegisteredObject Removes registered objects if present in the database C setTimeStepFunctionObject This function object overrides the calculation time step C solverInfo Writes solver information for a list of user-specified fields C syncObjects Copies content of local objectRegistry to all processors C systemCall Executes system calls, entered in the form of string lists C thermoCoupleProbes Sample probe for temperature using a thermocouple C timeActivatedFileUpdate Performs a file copy/replacement once a specified time has been reached C timeInfo Writes the run time (time-step), cpuTime and clockTime - optionally with cpuTime and clockTime change for each time step C viewFactorHeatFlux Determines radiation heat flux between patches when using the viewFactor radiation model C vtkWrite Writes fields in VTK (xml or legacy) format. Writes cell-values or point-interpolated values for volFields C writeDictionary Reports dictionary contents on change C writeObjects Allows specification of different writing frequency of objects registered to the database C properties Storage for function object properties, derived from IOdictionary . Provides functionality to read/write state information (data required for smooth restart behaviour) and results to/from the state dictionary C logFiles FunctionObject base class for creating, maintaining and writing log files e.g. integrated or averaged field data vs time C regionFunctionObject Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry C stateFunctionObject Base class for function objects, adding functionality to read/write state information (data required for smooth restart behaviour) and results to/from the state dictionary C timeControl Wrapper around functionObjects to add time control C timeFunctionObject Virtual base class for function objects with a reference to Time C valueAverageBase Base class that computes the ensemble- or time-based singular-value average values, with optional windowing, from the output of function objects that generate non-field type values, e.g. Cd of forceCoeffs momentum_x in momentum function objects C writeFile Base class for writing single files from the function objects C setTimeStepFaRegionsFunctionObject This function object controls the time step for classes of the type regionFaModel regionFaMaxCo entry from controlDict and evaluate the time step based on the finite area Courant Number C surfaceCourantNumber Computes the surface Courant number field at finite-area face centres C filmFlux Calculates the mass flux for surface film models C sixDoFRigidBodyState Writes the 6-DoF motion state C BilgerMixtureFraction Calculates the Bilger mixture-fraction field (i.e. C H, S and O are considered C specieReactionRates Writes the domain averaged reaction rates for each specie for each reaction into the file <timeDir>/specieReactionRates.dat N fv Namespace for finite-volume N gradientLimiters C cubic Cubic gradient limiter C minmod Minmod gradient limiter C Venkatakrishnan Venkatakrishnan gradient limiter C atmAmbientTurbSource Applies sources on k and either epsilon or omega to prevent them droping below a specified ambient value for atmospheric boundary layer modelling. Such adjustment reportedly increases numerical stability for very stable atmospheric stability conditions, and prevents nonphysical oscillations in regions of low shear at higher altitudes C atmBuoyancyTurbSource Applies sources on k and either epsilon or omega to incorporate effects of buoyancy for atmospheric boundary layer modelling C atmCoriolisUSource Applies corrections to incorporate the horizontal and vertical components of the Coriolis force for which the rotating frame is Earth C atmLengthScaleTurbSource Applies sources on either epsilon or omega to correct mixing-length scale estimations for atmospheric boundary layer modelling C atmNutSource Adds/subtracts a given artificial turbulent viscosity field to/from nut for atmospheric boundary layer modelling C atmPlantCanopyTSource Applies sources on temperature, i.e. T, to incorporate effects of plant canopy for atmospheric boundary layer modelling C atmPlantCanopyTurbSource Applies sources on either epsilon or omega to incorporate effects of plant canopy for atmospheric boundary layer modelling C atmPlantCanopyUSource Applies sources on velocity (i.e. U) to incorporate effects of plant canopy for atmospheric boundary layer modelling C option Base abstract class for handling finite volume options (i.e. fvOption) C iNew Return pointer to new fvOption object created C optionList List of finite volume options C options Finite-volume options, which is an IOdictionary of values and a fv::optionList C boundedConvectionScheme Bounded form of the selected convection scheme C convectionScheme Abstract base class for convection schemes C gaussConvectionScheme Basic second-order convection using face-gradients and Gauss' theorem C multivariateGaussConvectionScheme Basic second-order convection using face-gradients and Gauss' theorem C d2dt2Scheme Abstract base class for finite volume d2dt2 schemes C EulerD2dt2Scheme First-order Euler implicit d2dt2 using the current and two previous time-step values C steadyStateD2dt2Scheme SteadyState d2dt2 which returns 0 C backwardDdtScheme Second-order backward-differencing ddt using the current and two previous time-step values C boundedDdtScheme Bounded form of the selected ddt scheme C CoEulerDdtScheme Courant number limited first-order Euler implicit/explicit ddt C CrankNicolsonDdtScheme Second-oder Crank-Nicolson implicit ddt using the current and previous time-step fields as well as the previous time-step ddt C ddtSchemeBase Non-templated base class for ddt schemes C ddtScheme Abstract base class for ddt schemes C EulerDdtScheme Basic first-order Euler implicit/explicit ddt using only the current and previous time-step values C localEulerDdt C localEulerDdtScheme Local time-step first-order Euler implicit/explicit ddt C SLTSDdtScheme Stabilised local time-step first-order Euler implicit/explicit ddt. The time-step is adjusted locally so that an advective equations remains diagonally dominant C steadyStateDdtScheme SteadyState implicit/explicit ddt which returns 0 C divScheme Abstract base class for div schemes C gaussDivScheme Basic second-order div using face-gradients and Gauss' theorem C fourthGrad Second-order gradient scheme using least-squares C gaussGrad Basic second-order gradient scheme using face-interpolation and Gauss' theorem C gradScheme Abstract base class for gradient schemes C iterativeGaussGrad A second-order gradient scheme using face-interpolation, Gauss' theorem and iterative skew correction C LeastSquaresGrad Gradient calculated using weighted least-squares on an arbitrary stencil. The stencil type is provided via a template argument and any cell-based stencil is supported: C leastSquaresGrad Second-order gradient scheme using least-squares C LeastSquaresVectors Least-squares gradient scheme vectors C cellLimitedGrad CellLimitedGrad gradient scheme applied to a runTime selected base gradient scheme C cellMDLimitedGrad CellMDLimitedGrad gradient scheme applied to a runTime selected base gradient scheme C faceLimitedGrad FaceLimitedGrad gradient scheme applied to a runTime selected base gradient scheme C faceMDLimitedGrad FaceMDLimitedGrad gradient scheme applied to a runTime selected base gradient scheme C gaussLaplacianScheme Basic second-order laplacian using face-gradients and Gauss' theorem C laplacianScheme Abstract base class for laplacian schemes C relaxedNonOrthoGaussLaplacianScheme Basic second-order laplacian using face-gradients and Gauss' theorem C CentredFitSnGradScheme C correctedSnGrad Surface gradient scheme with full explicit non-orthogonal correction C faceCorrectedSnGrad Surface gradient scheme with full explicit non-orthogonal correction C limitedSnGrad Surface gradient scheme with limited explicit non-orthogonal correction C orthogonalSnGrad Surface gradient scheme with no non-orthogonal correction C relaxedSnGrad Surface gradient scheme with under-/over-relaxed full or limited explicit non-orthogonal correction C skewCorrectedSnGrad Surface gradient scheme with skewness and full explicit non-orthogonal corrections C snGradScheme Abstract base class for runtime selected snGrad surface normal gradient schemes C uncorrectedSnGrad Surface gradient scheme with no non-orthogonal correction C fusedGaussConvectionScheme Basic second-order convection using face-gradients and Gauss' theorem C fusedGaussDivScheme Variant of gaussDiv that avoids intermediates C fusedGaussGrad Basic second-order gradient scheme using face-interpolation and Gauss' theorem C fusedGaussLaplacianScheme C fusedLeastSquaresGrad Second-order gradient scheme using least-squares C cellSetOption Intermediate abstract class for handling cell-set options for the derived fvOptions C fixedTemperatureConstraint Constrain temperature equation (i.e. T) with a given set of fixed values within a specified region C velocityDampingConstraint Constrain given velocity fields to dampen velocity fluctuations exceeding a given value within a specified region C FixedValueConstraint Constrain values of given fields of Type with a given maximum value within a specified region, where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor C MapFieldConstraint The MapFieldConstraint Type with a source field from an external mesh, where <Type>={scalar,vector,sphericalTensor ,symmTensor ,tensor}. Optionally, the source field can be translated and/or rotated as a function of time C limitTemperature Corrects temperature field (i.e. T) within a specified region by applying limits between a given minimum and maximum C limitTurbulenceViscosity Corrects turbulence viscosity field (e.g. nut) within a specified region by applying a maximum limit, set according to a coefficient multiplied by the laminar viscosity: C limitVelocity Corrects velocity field (i.e. T) within a specified region by applying a given maximum velocity magnitude limit C interRegionOption Intermediate class for handling inter-region exchanges C acousticDampingSource Applies sources on velocity (i.e. U) within a specified region to enable acoustic damping C actuationDiskSource Applies sources on velocity (i.e. U) within a specified region to enable actuator disk models for aero/hydro thrust loading of horizontal axis turbines on surrounding flow field in terms of energy conversion processes C buoyancyEnergy Applies buoyancy energy sources (i.e. Sb) to the energy equation for compressible flows C buoyancyForce Applies buoyancy force sources (i.e. Sf) to the momentum equation for incompressible and compressible flows C buoyancyTurbSource Applies sources on turbulent kinetic energy (i.e. k) and either turbulent kinetic energy dissipation rate (i.e. epsilon) or specific dissipation rate (i.e. omega) to incorporate effects of buoyancy on turbulence in incompressible and compressible flows C directionalPressureGradientExplicitSource Applies an explicit pressure gradient source in such a way to deflect the flow towards an specific direction (flowDir). Alternatively add an extra pressure drop in the flowDir direction using a model C explicitPorositySource Applies an explicit porosity source to the momentum equation within a specified region C fanMomentumSource This source term models the action of a fan on the flow. It calculates flow rate through a set of upstream faces of encompassing the cell zone. The set of upstream faces is automatically calculated based on the flow direction and the surrounding face zone. Based on the flow rate, the pressure gradient is calculated based on the fan pressure curve and the thickness of the fan (measurement section). The pressure gradient is then added to the momentum equation C heatExchangerSource Heat exchanger source model for compressible flows, where the heat exchanger is modelled as an energy source using a selection of cells C jouleHeatingSource Evolves an electrical potential equation C meanVelocityForce Applies the force within a specified region to maintain the specified mean velocity for incompressible flows C patchMeanVelocityForce Applies the force over the specified patch to maintain the specified mean velocity for incompressible flows C multiphaseStabilizedTurbulence Applies corrections to the turbulent kinetic energy equation (i.e. k) and turbulent viscosity field (i.e. nut) for incompressible multiphase flow cases C patchCellsSource Source defined by a boundary condition applied to cells next to patches. This fvOption needs to be used with a boundarySourcePatch speciesSorption and enthalpySorption.) C PhaseLimitStabilization Stabilization source for phase transport equations of Type, where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor C radialActuationDiskSource Applies sources on velocity field (i.e. U) within a specified region to enable actuator disk models with radial thrust distribution for aero/hydro thrust loading of horizontal axis turbines on surrounding flow field in terms of energy conversion processes C rotorDiskSource Applies cell-based momentum sources on velocity (i.e. U) within a specified cylindrical region to approximate the mean effects of rotor forces C flapData C solidificationMeltingSource This source is designed to model the effect of solidification and melting processes, e.g. windhield defrosting, within a specified region. The phase change occurs at the melting temperature, Tmelt C tabulatedAccelerationSource Solid-body 6-DoF acceleration source C viscousDissipation Applies a viscous dissipation energy source to the energy equation C CodedSource C SemiImplicitSource Applies semi-implicit source within a specified region for Type, where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor. The source rate coefficients are specified as pairs of Su-Sp coefficients, i.e.: C interRegionExplicitPorositySource Applies inter-region explicit porosity source C constantHeatTransfer Applies a constant heat transfer model for inter-region heat exchanges C interRegionHeatTransferModel Intermediate class for handling inter-region heat exchanges C tabulatedHeatTransfer Applies a tabulated heat transfer model for inter-region heat exchanges C tabulatedNTUHeatTransfer Applies a tabulated heat transfer model for inter-region heat exchanges. The heat flux is calculated based on the Number of Thermal Units (NTU) C variableHeatTransfer Applies a variable heat transfer model depending on local values for inter-region heat exchanges C topOSource Implements Brinkman penalisation terms for topology optimisation. Looks up the indicator field (beta) from the registry, through topOVariablesBase C radiation Applies radiation sources (i.e. Sh) to the energy equation for compressible flows C multiphaseMangrovesSource C multiphaseMangrovesTurbulenceModel C VoFSolidificationMeltingSource Solidification and melting model for VoF simulations N porosityModels C addpowerLawLopesdaCostaToDebug C powerLawLopesdaCostaZone C powerLawLopesdaCosta Variant of the power law porosity model with spatially varying drag coefficient C DarcyForchheimer Darcy-Forchheimer law porosity model, given by: C fixedCoeff Fixed coefficient form of porosity model C powerLaw Power law porosity model, given by: C solidification Simple solidification porosity model N RASModels C kEpsilonLopesdaCosta Variant of the standard k-epsilon turbulence model with additional source terms to handle the changes in turbulence in porous regions represented by the powerLawLopesdaCosta porosity model C kL A one-equation (turbulent kinetic energy k) turbulence closure model for incompressible and compressible geophysical applications C kineticTheoryModel Kinetic theory particle phase RAS model C phasePressureModel Particle-particle phase-pressure RAS model C buoyantKEpsilon Additional buoyancy generation/dissipation term applied to the k and epsilon equations of the standard k-epsilon model C continuousGasKEpsilon K-epsilon model for the gas-phase in a two-phase system supporting phase-inversion C kOmegaSSTSato Implementation of the k-omega-SST turbulence model for dispersed bubbly flows with Sato (1981) bubble induced turbulent viscosity model C LaheyKEpsilon Continuous-phase k-epsilon model including bubble-generated turbulence C mixtureKEpsilon Mixture k-epsilon turbulence model for two-phase gas-liquid systems C EBRSM Manceau (2015)'s elliptic-blending Reynolds-stress turbulence model for incompressible and compressible flows C kEpsilon Standard k-epsilon turbulence model for incompressible and compressible flows including rapid distortion theory (RDT) based compression term C kEpsilonPhitF The k-epsilon-phit-f turbulence closure model for incompressible and compressible flows C kOmega Standard high Reynolds-number k-omega turbulence model for incompressible and compressible flows C kOmegaSST Implementation of the k-omega-SST turbulence model for incompressible and compressible flows C kOmegaSSTLM Langtry-Menter 4-equation transitional SST model based on the k-omega-SST RAS model C kOmegaSSTSAS Scale-adaptive URAS model based on the k-omega-SST RAS model C LaunderSharmaKE Launder and Sharma low-Reynolds k-epsilon turbulence model for incompressible and compressible and combusting flows including rapid distortion theory (RDT) based compression term C LRR Launder, Reece and Rodi Reynolds-stress turbulence model for incompressible and compressible flows C realizableKE Realizable k-epsilon turbulence model for incompressible and compressible flows C RNGkEpsilon Renormalization group k-epsilon turbulence model for incompressible and compressible flows C SpalartAllmaras Spalart-Allmaras one-transport-equation linear-eddy-viscosity turbulence closure model for incompressible and compressible external flows C SSG Speziale, Sarkar and Gatski Reynolds-stress turbulence model for incompressible and compressible flows N combustionModels C diffusion Simple diffusion-based combustion model based on the principle mixed is burnt. Additional parameter C is used to distribute the heat release rate in time C diffusionMulticomponent Diffusion based turbulent combustion model for multicomponent species C EDC Eddy Dissipation Concept (EDC ) turbulent combustion model C eddyDissipationDiffusionModel Eddy dissipation model based on the principle of mixed is burnt C eddyDissipationModelBase Standard Eddy Dissipation Model based on the assumption that the reaction rates are controlled by the turbulece time length scale. The chemical reaction rate is governed by the large-eddy mixing scale, (ie k/epsilon). Combustion takes place whenever the turbulence is present C FSD Flame Surface Dennsity (FDS) combustion model C infinitelyFastChemistry Simple infinitely fast chemistry combustion model based on the principle mixed is burnt. Additional parameter C is used to distribute the heat release rate.in time C laminar Laminar combustion model C noCombustion Dummy combustion model for 'no combustion' C PaSR Partially stirred reactor turbulent combustion model C singleStepCombustion Base class for combustion models using singleStepReactingMixture C zoneCombustion Zone-filtered combustion model N reactionRateFlameAreaModels C relaxation Consumption rate per unit of flame area obtained from a relaxation equation N ccm C base Base functionality common to reader and writer classes C interfaceEntry A STARCCM interface definition is a pair of boundary ids C interfaceDefinitions A list of available interface definitions C reader Reads CCM files as written by PROSTAR/STARCCM C options C namesList A linked-list that is searchable by the 'name() ' of the items C fieldEntry A ccm field entry with short name, name, maxId and type C solutionEntry A ccm solution entry with name, iteration and time C fieldTable A list of the available fields C writer Write OpenFOAM meshes and/or results to CCM format N ensightOutput A collection of functions for writing ensight file content C writerCaching State information for writers with collated times N fileFormats Namespace to isolate specifics for file formats, and some common utilities C FIREMeshReader Read AVL/FIRE fpma, fpmb files C FIREMeshWriter Writes polyMesh in AVL/FIRE polyhedra format (fpma, fpmb) C STARCDMeshReader Read PROSTAR vrt/cel/bnd files. The protected data in meshReader are filled C STARCDMeshWriter Writes polyMesh in PROSTAR (v4) bnd/cel/vrt format C ABAQUSCore Core routines used when reading/writing ABAQUS files C readHelper Raw reader structure C FIRECore Core routines used when reading/writing AVL/FIRE files C NASCore Core routines used when reading/writing NASTRAN files C STARCDCore Core routines used when reading/writing PROSTAR vrt/cel/bnd files C STLCore Core routines used when reading/writing STL files C STLReader Internal class used by the STLsurfaceFormat and triSurface C edgeMeshFormat Provide a means of reading/writing the single-file OpenFOAM edge format C edgeMeshFormatsCore A collection of helper functions for reading/writing edge formats C NASedgeFormat Nastran edge reader C OBJedgeFormat Provide a means of reading/writing Alias/Wavefront OBJ format C STARCDedgeFormat Read/write the lines from PROSTAR vrt/cel files C VTKedgeFormat Provide a means of writing VTK legacy format C extendedEdgeMeshFormat Provide a means of reading/writing the single-file OpenFOAM extendedEdgeMesh format C extendedFeatureEdgeMeshFormat Provide a means of reading extendedFeatureEdgeMesh as featureEdgeMesh C ABAQUSsurfaceFormat Abaqus surface reader C ABAQUSsurfaceFormatCore Internal class used by the ABAQUSsurfaceFormat C AC3DsurfaceFormat Read/write AC3D format C AC3DsurfaceFormatCore Internal class used by the AC3DsurfaceFormat C FLMAsurfaceFormat Provide a means of writing AVL/FIRE FLMA format C FLMAZsurfaceFormat C GTSsurfaceFormat Read/write GTS format C NASsurfaceFormat Nastran surface reader/writer C OBJsurfaceFormat Read/write Alias/Wavefront OBJ format C OFFsurfaceFormat Read/write Geomview OFF polyList format C SMESHsurfaceFormat Write tetgen SMESH format (Tetgen http://tetgen.berlios.de ) C STARCDsurfaceFormat Read/write the surface shells from PROSTAR vrt/cel files C STARCDsurfaceFormatCore Internal class used by the STARCDsurfaceFormat C STLsurfaceFormat Provide a means of reading/writing STL files (ASCII and BINARY) C surfaceFormatsCore A collection of helper functions for reading/writing surface formats C TRIReader TRI (triangle) file reader C TRIsurfaceFormat Provide a means of reading/writing .tri format C VTKsurfaceFormat Read/write VTK legacy format (ASCII) for surfaces C VTKsurfaceFormatCore Internal class used by the VTKsurfaceFormat Format is LEGACY_ASCII C VTPsurfaceFormat Write surfaces in VTP (xml) format. The default format is INLINE_BASE64 C VTPsurfaceFormatCore Internal class used by the VTPsurfaceFormat . The default format is INLINE_BASE64 C X3DsurfaceFormat Provide a means of writing x3d format C X3DsurfaceFormatCore Internal class used by the X3DsurfaceFormat C ensightMeshReader Notes N vtk Namespace for handling VTK output. Contains classes and functions for writing VTK file content N Tools A collection of static methods to assist converting OpenFOAM data structures into VTK internal data structures C Patch Convert OpenFOAM patch to vtkPolyData C Caching Bookkeeping for internal caching C vtuAdaptor Bookkeeping for vtkUnstructuredGrid C GenericPatchGeoFieldsWriter A Foam::vtk::GenericPatchWriter with support for geometric fields C internalWriter Write an OpenFOAM volume (internal) geometry and internal fields as a vtu file or a legacy vtk file C patchWriter Write OpenFOAM patches and patch fields in VTP or legacy vtk format C surfaceFieldWriter Write surfaces fields (as PointData ) in VTP format. Legacy VTK format is intentionally not supported C fileWriter Base class for VTK output writers that handle geometry and fields (eg, vtp, vtu data). These output formats are structured as DECLARED, FIELD_DATA, PIECE followed by any CELL_DATA or POINT_DATA C seriesWriter Provides a means of accumulating and generating VTK file series C vtmWriter Provides a means of accumulating file entries for generating a vtkMultiBlockDataSet (.vtm) file C appendBase64Formatter Appended base-64 encoded binary output. Uses an output filter layer to write base-64 encoded content C appendRawFormatter Appended raw binary output C asciiFormatter Inline ASCII output. Adds spaces between entries and a newline every 9 items (for consistency with what VTK itself outputs) C base64Formatter Inline base-64 encoded binary output. Uses an output filter layer to write base-64 encoded content C foamVtkBase64Layer Base-64 encoded output layer - normally only used indirectly by formatters C formatter Abstract class for a VTK output stream formatter C legacyAsciiFormatter Formatting as per Foam::vtk::asciiFormatter , but with naming for legacy output C legacyRawFormatter Binary output for the VTK legacy format, always written as big-endian and with 32-bit integers C outputOptions Encapsulated combinations of output format options. This is primarily useful when defining the output type based on some command-line arguments or dictionary contents. However, it can also be a useful alternative to using the underlying enumeration directly, since this class provides additional methods not possible with an enum C vtuCells A deep-copy description of an OpenFOAM volume mesh in data structures suitable for VTK UnstructuredGrid, including the possibility of decomposing polyhedral cells into primitive cell types C vtuSizing Sizing descriptions and routines for transcribing an OpenFOAM volume mesh into a VTK unstructured grid, with possible decomposition of polyhedral cells into primitive cell types C lineWriter Write edge/points (optionally with fields) as a vtp file or a legacy vtk file C polyWriter Write faces/points (optionally with fields) as a vtp file or a legacy vtk file C surfaceWriter Write faces/points (optionally with fields) as a vtp file or a legacy vtk file C lagrangianWriter Write lagrangian (cloud) positions and fields (as PointData ) in VTP format. Legacy VTK format is intentionally not supported since the VTP format provides much better field selection in ParaView, and for consistency with the Foam::functionObjects::vtkCloud function object C coordSetWriter Write as points/lines, optionally with fields, as a vtp file or a legacy vtk file C internalMeshWriter Write an OpenFOAM volume (internal) geometry and internal fields as a vtu file or a legacy vtk file C GenericPatchWriter Write concrete PrimitivePatch faces/points (optionally with fields) as a vtp file or a legacy vtk file. The patch type is limited to representations of polygon faces and 3D points and must support the following methods: C patchMeshWriter Write OpenFOAM patches and patch fields in VTP or legacy vtk format N simplifiedMeshes C simplifiedDynamicFvMeshBase C SimplifiedDynamicFvMesh C columnFvMeshInfo C columnFvMesh Generates a 1D column representation of a mesh based on an existing mesh and/or fields C hexCellFvMesh Generates a single hex cell representation of a mesh N pointSmoothers C equipotentialPointSmoother C geometricElementTransformPointSmoother Geometric Element Transformation Method (GETMe) point smoother. Points are moved in a direction normal to the face of the dual element. This tends to orthogonalise elements. This method can "push" as well as "pull" C laplacianConstraintPointSmoother C laplacianPointSmoother N Detail Implementation details for various OpenFOAM classes C zoneSubSet C STLAsciiParse Internal class used when parsing STL ASCII format C STLAsciiParseManual A lexer for parsing STL ASCII files C parcelSelection Selection of parcels based on their objectRegistry entries. Normally accessed via a dictionary entry C PackedListCore Template-invariant parts for PackedList C isPointerLike Pointer-like behaviour C isPointerLike< autoPtr< T > > Pointer-like behaviour for autoPtr C isPointerLike< std::unique_ptr< T > > Pointer-like behaviour for std::unique_ptr C HashTablePair Internal storage type for HashTable entries C HashTableSingle Internal storage type for HashSet entries C PtrListDetail A rudimentary list of pointers used for PtrList , UPtrList , etc. This class is considered implementation detail and should not normally be used other than by OpenFOAM container classes C StreamAllocator A wrapper to hold a std::stream type for OpenFOAM wrapped streams. This is necessary since the OpenFOAM streams hold a reference to the normal std::stream C MeshedSurfaceIOAllocator A helper class for storing points and faces with IO capabilities N fa Namespace for finite-area C limitHeight Limits the film height to a specified max value C limitVelocity Limits the maximum velocity magnitude to the specified max value C faceSetOption Intermediate abstract class for handling face-set options for the derived faOptions C option Base abstract class for handling finite area options (i.e. faOption) C iNew Return pointer to new faOption object created on the freestore from an Istream C optionList List of finite-area options C options Finite-area options, which is an IOdictionary of values and a fa::optionList C contactHeatFluxSource Applies contact heat flux between specified faMesh fvMesh C externalFileSource Applies sources on a specified field within a specified region by using an external table file C externalHeatFluxSource Applies a heat flux condition for a specified faMesh C jouleHeatingSource Evolves an electrical potential equation C convectionScheme Abstract base class for finite area calculus convection schemes C gaussConvectionScheme Basic second-order convection using face-gradients and Gauss' theorem C EulerFaD2dt2Scheme First-order Euler implicit d2dt2 using the current and two previous time-step values C faD2dt2Scheme Abstract base class for d2dt2 schemes C backwardFaDdtScheme Second-order backward-differencing implicit ddt using the current and two previous time-step values C boundedBackwardFaDdtScheme C EulerFaDdtScheme C faDdtScheme C steadyStateFaDdtScheme C divScheme Abstract base class for finite area calculus div schemes C gaussDivScheme Basic second-order div using face-gradients and Gauss' theorem C gradScheme Abstract base class for finite area calculus gradient schemes C gaussGrad Basic second-order gradient scheme using face-interpolation and Gauss' theorem C leastSquaresFaGrad Second-order gradient scheme using least-squares C edgeLimitedGrad EdgeLimitedGrad gradient scheme applied to a runTime selected base gradient scheme C faceLimitedGrad FaceLimitedGrad gradient scheme applied to a runTime selected base gradient scheme C laplacianScheme Abstract base class for finite area calculus laplacian schemes C gaussLaplacianScheme Basic second-order laplacian using face-gradients and Gauss' theorem C correctedLnGrad Simple central-difference lnGrad scheme with non-orthogonal correction C fourthLnGrad Fourth-order snGrad scheme with non-orthogonal correction C limitedLnGrad Central-difference lnGrad scheme with limited non-orthogonal correction C lnGradScheme Abstract base class for lnGrad schemes C uncorrectedLnGrad Simple central-difference lnGrad scheme with no non-orthogonal correction N ensight C FileName Specification of a valid Ensight file-name C VarName Specification of a valid Ensight variable-name N glTF Namespace for handling glTF creation. https://www.khronos.org/registry/glTF/ C accessor GlTF accessor C animation GlTF animation C glTFSampler C glTFTarget C glTFChannel C base Base class for glTF entities C bufferView GlTF buffer view - provides a view/slice of the glTF buffer C List Container for glTF entities C mesh GlTF mesh C object GlTF binary object C scene Main class to assemble glTF components into a scene C sceneWriter Wrapper for glTF scene for file output N meshObjects C gravity Gravitational acceleration vector Although termed a MeshObject Time only and thus identical for all regions N SRF Namespace for single rotating frame (SRF ) models C rpm Basic SRF model whereby angular velocity is specified in terms of a (global) axis and revolutions-per-minute [rpm] C SRFModel Top level model for single rotating frame N updateablePatchTypes C updateableSnGrad N expressions A namespace for expression-related classes/traits etc N patchExpr Namespace for patch expressions parsing and evaluation C parseDriver Driver for patch expressions C parser Lemon parser interface for patch expressions grammar C scanner Ragel lexer/scanner interface for patch expressions N volumeExpr Namespace for volume field expressions parsing and evaluation C parseDriver Driver for volume, surface, point field expressions C parser Lemon parser interface for volume expressions grammar C scanner Ragel lexer/scanner interface for volume expressions N exprDriverOps Miscellaneous operations used in combination with the expressions::exprDriver C swakModuloOp A modulo operation similar to that used in swak4foam N fieldExpr Namespace for primitive field expressions parsing and evaluation C parseDriver Driver for generic primitive field expressions C parser Lemon parser interface for field expressions grammar C scanner Ragel lexer/scanner interface for patch expressions N Detail A namespace for implementation details related to expressions C exprValueUnion The data content (as a union) C fvExprDriver Base driver for parsing value expressions associated with an fvMesh C fvExprDriverWriter Registered input/output for an expressions::fvExprDriver C patchExprFieldBase Base class for managing patches with expressions. The expected input supports value, gradient and mixed conditions C exprDriver Base driver for parsing (field) values C boolOp Convert [0-1] values (usually scalars) as false/true C boolNotOp Inverse of boolOp() C boolOp< bool > Convert to bool, pass-through for bool C boolNotOp< bool > Inverse of boolOp , no conversion required for bool C boolAndOp Logical 'and', possibly with scalars as (false, true) values C boolOrOp Logical 'or', possibly with scalars as (false, true) values C boolXorOp Logical 'xor', possibly with scalars as (false, true) values C exprResult A polymorphic field/result from evaluating an expression C exprResultDelayed An exprResult with an additional delay before evaluation C exprResultGlobals A globally available registry of expression results. These are currently registered on Time (may change in the future) C Table The table of results C exprResultStack A stack of polymorphic fields. Can be used to build a list of results one at a time C exprResultStored An exprResult with persistence C exprResultStoredStack An exprResultStack with persistence C exprString A variant of Foam::string with expansion of dictionary variables into a comma-separated form C scanToken A low-level input/scan token content. No defined constructors/destructors. All memory management is manual! C exprValue A polymorphic typed union of simple primitive and VectorSpace types. It uses a 'fatter' representation that includes standard VectorSpace types, which avoids heap allocations at the expense of more storage. This is mostly not an issue since lists and fields would box/unbox an entire field, not individual values C exprValueFieldTag An expressions::exprValue (polymorphic typed union) with an additional flag for tracking Field content as uniform etc C combineOp Binary combine operator, e.g. for global reduction N Function1Types C Lookup Function1 to lookup UniformDimensionedField from an objectregistry C Function1Expression Function1 with values supplied by a parsed expression C CodedFunction1 Function1 with the code supplied by an on-the-fly compiled C++ expression C Constant Templated function that returns a constant value C Cosine A templated cosine function, with support for offset etc C CSV Templated CSV function C FunctionObjectTrigger Returns a 0/1 value corresponding to function object trigger levels C FunctionObjectValue Returns a value retrieved from a function object result C halfCosineRamp Half-cosine ramp function starting from 0 and increasing to 1 from start over the duration and remaining at 1 thereafter C InputValueMapper Function1 wrapper that maps the input value prior to it being used by another Function1 C linearRamp Linear ramp function starting from 0 and increasing linearly to 1 from start over the duration and remaining at 1 thereafter C None Templated placeholder function that returns an error message if called C OneConstant Templated function that returns the corresponding 1 (one) C Polynomial C quadraticRamp Quadratic ramp function starting from 0 and increasing quadratically to 1 from start over the duration and remaining at 1 thereafter C quarterCosineRamp Quarter-cosine ramp function starting from 0 and increasing to 1 from start over the duration and remaining at 1 thereafter C quarterSineRamp Quarter-sine ramp function starting from 0 and increasing to 1 from start over the duration and remaining at 1 thereafter C ramp Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically to 1 from start over the duration and remaining at 1 thereafter C Scale Function1 which scales a given 'value' function by a scalar 'scale' function C Sine A templated sine function, with support for offset etc C Square A templated square-wave function with support for offset, etc C stepFunction A step function that is 0 before start changing to 1 for the duration and returning to 0 thereafter C Table Templated table container function C TableBase Base class for table with bounds handling, interpolation and integration C TableFile Templated table container function where data are read from file C Uniform Templated function that returns a constant value C ZeroConstant Templated function that returns the corresponding 0 (zero) C reverseRamp Reverse ramp function starting from 1 and decreasing stepRamply to a min. user-specified value from start over the duration and remaining constant thereafter C stepRamp Linear ramp function starting from 0 and increasing stepRamply to 1 from start over the duration and remaining at 1 thereafter C Sample N PatchFunction1Types C LookupField PatchFunction1 to lookup volField/surfaceField or pointField from an objectregistry and return its value on the patch C PatchExprField PatchFunction1 with values supplied by a parsed expression C Sampled PatchFunction1 to sample an existing field C CodedField PatchFunction1 with the code supplied by an on-the-fly compiled C++ expression C ConstantField Templated function that returns a constant value C MappedFile Patch value mapping from a set of values stored in a file and a set of unstructured points using the following directory structure: C FilterField The FilterField helper class provides a multi-sweep median filter for a Field of data associated with a geometric point cloud C UniformValueField Templated function that returns a uniform field based on a run-time selectable Function1 entry N Expression A namespace for expression templates C fvMatrixExpression Expression of fvMatrix C fvMatrixRefWrap Expression wrap of non-const reference to fvMatrix C fvMatrixConstRefWrap Expression wrap of const reference to fvMatrix C fvm_add C fvm_subtract C fvm_negate C fvMatrixInternal FvMatrix, internal parts and dimensions only. No upper/lower/boundaryCoeffs C interpolate C linearInterpolate C ListExpression Expression templates for List C ListConstRefWrap Expression wrap of const reference to UList C const_iterator C UniformListWrap Expression wrap of a List with a uniform value C const_iterator C UniformGeometricFieldWrap C boolWrap Expression wrap of non-const bool C boolConstWrap Expression wrap of const bool C dimensionSetRefWrap Expression wrap of non-const reference to dimensionSet C dimensionSetConstRefWrap Expression wrap of const reference to dimensionSet C GenericExpression C g_negate C g_sqr C g_sqrt C g_magSqr C g_symm C g_pow2 C g_pow3 C g_pow4 C g_compl C g_add C g_subtract C g_multiply C g_divide C g_or C g_and C g_bitand C g_bitor C g_xor C UniformGeometricFieldWrap2 C GeometricFieldExpression Expression of GeometricField C GeometricFieldRefWrap Expression wrap of non-const reference to GeometricField C GeometricFieldConstRefWrap Expression wrap of const reference to GeometricField C GeometricFieldConstTmpWrap Expression wrap of const tmp to GeometricField C GF_add C GF_sin GeometricField expressions C GF_cos C GF_tan C GF_sinh C GF_cosh C GF_tanh C GF_sqr C GF_sqrt C GF_magSqr C GF_mag C GF_symm C GF_pow2 C GF_pow3 C GF_pow4 C GF_min C GF_max C GF_subtract C GF_multiply C GF_divide C GF_dot C ListWrap Expression wrap of a List C ListRefWrap Expression wrap of non-const reference to List C ListTmpWrap Expression wrap of tmp to List C ListConstTmpWrap Expression wrap of const tmp to List C const_iterator Define our own iterator so we can refer to it. 'normal', e.g. double* C IndirectConstWrap Expression wrap of indirection C const_iterator C List_negate List negation C const_iterator C List_sin Expression wrapping function for unary sin function C const_iterator C List_cos Expression wrapping function for unary cos function C const_iterator C List_tan Expression wrapping function for unary tan function C const_iterator C List_sinh Expression wrapping function for unary sinh function C const_iterator C List_cosh Expression wrapping function for unary cosh function C const_iterator C List_tanh Expression wrapping function for unary tanh function C const_iterator C List_sqr Expression wrapping function for unary sqr function C const_iterator C List_sqrt Expression wrapping function for unary sqrt function C const_iterator C List_magSqr Expression wrapping function for unary magSqr function C const_iterator C List_mag Expression wrapping function for unary mag function C const_iterator C List_symm Expression wrapping function for unary symm function C const_iterator C List_pow2 Expression wrapping function for unary pow2 function C const_iterator C List_pow3 Expression wrapping function for unary pow3 function C const_iterator C List_pow4 Expression wrapping function for unary pow4 function C const_iterator C List_min Expression wrapping function for binary min function C const_iterator C List_max Expression wrapping function for binary max function C const_iterator C List_add List operators C const_iterator C List_subtract C const_iterator C List_multiply C const_iterator C List_divide C const_iterator C List_dot C const_iterator C List_interpolate Not possible: a *= b has to return a new type so it can never be in-place C const_iterator C UniformListWrap2 Expression wrap of a uniform value without a List size C const_iterator C ListsConstRefWrap Expression wrap of multiple lists (e.g. FieldField ) C const_iterator C ListsRefWrap Expression wrap of multiple lists C const_iterator C iterator N turbulence C IntegralScaleBox Class to describe the integral-scale container being used in the turbulentDigitalFilterInletFvPatchField N patchDistMethods C advectionDiffusion Calculation of approximate distance to nearest patch for all cells and boundary by solving the Eikonal equation in advection form with diffusion smoothing C directionalMeshWave Variant of meshWave C meshWave Fast topological mesh-wave method for calculating the distance to nearest patch for all cells and boundary C meshWaveAddressing Variant of patchDistMethods::meshWave that stores nearest-wall addressing instead of directly transporting wall information C Poisson Calculation of approximate distance to nearest patch for all cells and boundary by solving Poisson 's equation C exact Calculation of exact distance to nearest patch for all cells and boundary by constructing a search tree for all patch faces N limitFuncs Namespace for limiting functions C null C magSqr C rhoMagSqr N binModels C singleDirectionUniformBin Calculates binned data in a specified direction C uniformBin Calculates binned data in multiple segments according to a specified Cartesian or cylindrical coordinate system N DMDModels A namespace for various dynamic mode decomposition (DMD) model implementations C STDMD Streaming Total Dynamic Mode Decomposition (i.e. STDMD N heatTransferCoeffModels A namespace for various heat transfer coefficient model implementations C faceZoneReferenceTemperature Heat transfer coefficient calculation that employs the area-average temperature of a specified face zone as the reference temperature C fixedReferenceTemperature Heat transfer coefficient calculation that employs a fixed reference temperature C localReferenceTemperature Heat transfer coefficient calculation that employs the patch internal field as the reference temperature C ReynoldsAnalogy Heat transfer coefficient calculation based on Reynolds Analogy, which is used to relate turbulent momentum and heat transfer N histogramModels A namespace for various histogram model implementations C equalBinWidth Histogram model which groups data into bins of equal width C unequalBinWidth Histogram model which groups data into bins of unequal widths N resolutionIndexModels A namespace for various resolutionIndex model implementations C CelikEtaIndex Computes a single-mesh resolution index according to Celik et al.'s index using Kolmogorov length scale, which is used as a LES/DES quality/post verification metric that does not require any experimental or DNS data C CelikNuIndex Computes a single-mesh resolution index according to Celik et al.'s index using effective viscosity, which is used as a LES/DES quality/post verification metric that does not require any experimental or DNS data C PopeIndex Computes a single-mesh resolution index according to Pope's index, which is used as a LES/DES quality/post-verification metric that does not require any experimental or DNS data N wallHeatFluxModels A namespace for various heat-flux model implementations C gauge This model computes the wall-heat flux at a selected patch using imaginary heat-flux gauges C wall This model computes the wall-heat flux at selected wall patches N substitutionModels C dictionaryValue The dictionaryValue C environmentVariable The environmentVariable C fileRegEx The fileRegEx C functionObjectValue FunctionObjectValue substitution model C userValue The userValue N SVG Collection of tools to generate SVG strings C element C text C line C header N heatExchangerModels A namespace for various heat exchanger model implementations C effectivenessTable A heat exchanger model where heat exchange is calculated via an effectiveness table C referenceTemperature A heat exchanger model where heat exchange is calculated via a temperature table N distributionModels A namespace for various probability distribution model implementations C binned Particle-size distribution model wherein random samples are drawn from a given discrete set of (bin, probability) pairs, where in terms of its meaning, bins correspond to particle sizes and probabilities correspond to (relative) probability of occurrences C exponential Particle-size distribution model wherein random samples are drawn from the doubly-truncated exponential probability density function: C fixedValue Particle-size distribution model wherein samples are given fixed values C general Particle-size distribution model wherein random samples are drawn from a given arbitrary probability density function or cumulative distribution function. Input distributions are specified as pairs of (size, probability) (i.e. (point, value) ) C massRosinRammler Particle-size distribution model wherein random samples are drawn from the two-parameter Rosin-Rammler (Weibull) probability density function corrected to take into account varying number of particles per parcels for fixed-mass parcels C multiNormal Particle-size distribution model wherein random samples are drawn from a mixture of a finite set of doubly-truncated univariate normal probability density functions: C normal Particle-size distribution model wherein random samples are drawn from the doubly-truncated univariate normal probability density function: C RosinRammler Particle-size distribution model wherein random samples are drawn from the doubly-truncated two-parameter Rosin-Rammler (Weibull) probability density function: C uniform Particle-size distribution model wherein random samples are drawn from the doubly-truncated uniform probability density function: N integrationSchemes C analytical Analytical integration scheme C Euler N radiation Namespace for radiation modelling C cloudAbsorptionEmission Retrieves absorption/emission data from a cloud object C cloudScatter Cloud radiation scatter model C greyDiffusiveRadiationMixedFvPatchScalarField This boundary condition provides a grey-diffuse condition for radiation intensity, I, for use with the finite-volume discrete-ordinates model (fvDOM ), in which the radiation temperature is retrieved from the temperature field boundary condition C greyDiffusiveViewFactorFixedValueFvPatchScalarField This boundary condition provides a grey-diffuse condition for radiative heat flux, qr, for use with the view factor model C MarshakRadiationFvPatchScalarField C MarshakRadiationFixedTemperatureFvPatchScalarField C specularRadiationMixedFvPatchScalarField This boundary condition provides a specular radiation condition for axisymmetric and symmetry-plane fvDOM C wideBandDiffusiveRadiationMixedFvPatchScalarField This boundary condition provides a wide-band, diffusive radiation condition, where the patch temperature is specified C absorptionCoeffs C blackBodyEmission Class black body emission C fvDOM Finite Volume Discrete Ordinates Method. Solves the RTE equation for n directions in a participating media, not including scatter and reflective walls C radiativeIntensityRay Radiation intensity for a ray in a given direction C noRadiation No radiation - does nothing to energy equation source terms (returns zeros) C opaqueSolid Radiation for solid opaque solids - does nothing to energy equation source terms (returns zeros) but creates absorptionEmissionModel and scatterModel C P1 Works well for combustion applications where optical thickness, tau is large, i.e. tau = a*L > 3 (L = distance between objects) C radiationModel Top level model for radiation modelling C solarLoad The solarLoad C solarLoadBase Base class for solarLoad models C viewFactor View factor radiation model. The system solved is: C q = b where: Cij = deltaij/Ej - (1/Ej - 1)Fij q = heat flux b = A eb - Ho and: eb = sigma*T^4 Ej = emissivity Aij = deltaij - Fij Fij = view factor matrix C absorptionEmissionModel Model to supply absorption and emission coefficients for radiation modelling C binaryAbsorptionEmission Radiation coefficient based on two absorption models C constantAbsorptionEmission Constant radiation absorption and emission coefficients for continuous phase C greyMeanAbsorptionEmission GreyMeanAbsorptionEmission radiation absorption and emission coefficients for continuous phase C greyMeanSolidAbsorptionEmission GreyMeanSolidAbsorptionEmission radiation absorption and emission coefficients for solid mixture C multiBandAbsorptionEmission MultiBandAbsorptionEmission radiation absorption/emission for solids C multiBandZoneAbsorptionEmission MultiBandZoneAbsorptionEmission radiation absorption/emission for solids C noAbsorptionEmission Dummy absorption-emission model for 'none' C wideBandAbsorptionEmission WideBandAbsorptionEmission radiation absorption and emission coefficients for continuous phase C boundaryRadiationProperties Boundary radiation properties holder C boundaryRadiationPropertiesPatch C lookup Lookup type of boundary radiation properties C opaqueDiffusive Radiation boundary model for opaque diffusive walls. It requires to specify a wallAbsorptionEmissionModel in boundaryRadiationProperties file C opaqueReflective Radiation boundary model for opaque reflective walls. It requires to specify a wallAbsorptionEmissionModel and the reflected fraction in boundaryRadiationProperties file fd is the diffusive reflected fraction. 0 all the incoming flux is specularly reflected and 1 all is diffusive reflected. fd is used in the calculation of the specular reflection (rSpec) and the diffusive reflection (rDiff). Absorptivity and emissivity are independent of fd C transparent Radiation boundary model for transparent walls. It requires to specify a wallAbsorptionEmissionModel in boundaryRadiationProperties file C constantScatter Constant radiation scatter coefficient C noScatter Dummy scatter model for 'none' C scatterModel Base class for radiation scattering C mixtureFractionSoot This soot model is purely an state model. The amount of soot produced is determined by a single step chemistry as : C noSoot NoSoot C sootModel Base class for soot models C constantAbsorption Constant radiation transmissivity coefficient C multiBandAbsorption MultiBandAbsorption radiation transmissivity for solids C solidAbsorption Radiation absorptivity-emissivity model to be used on walls on inter-region patches when the solid opaque radiation model is used in the solid and the wall emissivity and absorptivity are taken from the solid radiation properties C wallAbsorptionEmissionModel Based class for wall absorption emission models C constantTransmissivity Constant radiation transmissivity coefficient C multiBandTransmissivity MultiBandTransmissivity radiation transmissivity for solids C wallTransmissivityModel Base class for wall transmissivity models C fixedIncidentRadiationFvPatchScalarField Boundary condition for thermal coupling for solid regions. Used to emulate a fixed incident radiative heat flux on a wall C laserDTRM Discrete Tray Radiation Method for collimated radiation flux. At the moment the particles are injected on a 2D disk in polar coordinates providing starting and finish locations C localDensityAbsorptionEmission Constant radiation absorption and emission coefficients for continuous phase C Fresnel General Fresnel reflection model bewtween a dialectric and an absorbing medium C FresnelLaser Modified Fresnel reflection model C noReflection Dummy scatter model for 'none' C reflectionModel Base class for radiation scattering N cloudFunctionObjectTools C collector Implementation of template-invariant tools for various function objects such as Foam::ParticleHistogram N regionModels N surfaceFilmModels C kinematicSingleLayer Kinematic form of single-cell layer surface film model C noFilm Dummy surfaceFilmModel to allow solvers supporting film simulations to be run without a film region C filmSubModelBase Base class for surface film sub-models C constantFilmThermo Constant thermo model C thermoData C filmThermoModel Base class for film thermo models C liquidFilmThermo Liquid thermo model C filmTurbulenceModel Base class for film turbulence models C laminar Film laminar turbulence model C contactAngleForce Base-class for film contact angle force models C distributionContactAngleForce PDF distribution based film contact angle force C perturbedTemperatureDependentContactAngleForce Temperature dependent contact angle force with a stochastic perturbation C temperatureDependentContactAngleForce Temperature dependent contact angle force C force Base class for film (stress-based) force models C forceList List container for film sources C thermocapillaryForce Thermocapillary force C BrunDrippingInjection Film Dripping mass transfer model C curvatureSeparation Curvature film separation model C drippingInjection Film dripping mass transfer model C injectionModel Base class for film injection models, handling mass transfer from the film C injectionModelList List container for film injection models C patchInjection Remove and inject the mass in the film as it passes over the selected patches C transferModel Base class for film transfer models, handling mass transfer between the film and the continuous phase C transferModelList C constantRadiation Film constant radiation model. The constant radiative flux is specified by the user, and operated over a time interval defined by a start time and duration. In addition, a mask can be applied to shield the film from the radiation C filmRadiationModel Base class for film radiation models C noRadiation Dummy radiation model for 'none' option C primaryRadiation Radiation model whereby the radiative heat flux is mapped from the primary region C standardRadiation Standard radiation model C ArrheniusViscosity The Arrhenius temperature-dependent viscosity model multiplies the viscosity of a base model by an Arrhenius-type temperature function: C constantViscosity Constant viscosity model C filmViscosityModel Base class for surface film viscosity models C function1Viscosity The Foam::Function1 temperature-dependent viscosity model multiplies the viscosity of a base model by a Function1 temperature function C liquidViscosity LiquidViscosity viscosity model C thixotropicViscosity Thixotropic viscosity model based on the evolution of the structural parameter C waxSolventViscosity Wax solvent mixture viscosity model C constantHeatTransfer Constant heat transfer model C heatTransferModel Base class for film heat transfer models C mappedConvectiveHeatTransfer Convective heat transfer model based on a re-working of a Nusselt number correlation C noPhaseChange Dummy phase change model for 'none' C phaseChangeModel Base class for surface film phase change models C solidification Solidification phase change model where all film mass is converted when the local temperature > activation temperature. The latent heat is assumed to be removed by heat-transfer to the wall C standardPhaseChange Standard phase change model with modification for boiling C waxSolventEvaporation C surfaceFilmRegionModel Base class for surface film models C thermoSingleLayer Thermodynamic form of single-cell layer surface film model C VoFPatchTransfer Transfer mass between the film and the VoF in the continuous phase N areaSurfaceFilmModels C kinematicThinFilm Thin film model C kinematicThinFilmIBM Thin film model with support for immersed boundary method (IBM) C regionFaIBM Immersed Boundary Method (IBM) for finite area (FA). Multiple IBM surfaces can be defined, each represented by a triangulated surface mesh. Boundary motion is supported via a solidBodyMotionFunction C regionFaIBMList Immersed Boundary Method (IBM) for finite area (FA) C liquidFilmBase C liquidFilmModel C filmSubModelBase C filmTurbulenceModel Base class for film turbulence models C laminar Film laminar turbulence model C contactAngleForce Base-class for film contact angle force models C dynamicContactAngleForce Film-speed or film-temperature dependent contact-angle force with a stochastic perturbation C force Base class for film (stress-based) force models C forceList C BrunDrippingInjection Film-dripping mass-transfer model C filmSeparation The filmSeparation C injectionModel Base class for film injection models, handling mass transfer from the film C injectionModelList N pyrolysisModels C noPyrolysis Dummy surface pyrolysis model for 'none' C pyrolysisModel Base class for pyrolysis models C pyrolysisModelCollection A centralized pyrolysis collection C reactingOneDim Reacting, 1-D pyrolysis model NOTE: The moveMesh option can only be applied to solid reaction such as: PMMA -> gas at the moment C thermo Pyrolysis model which solves only the energy equation in the region N thermalBaffleModels C noThermo Dummy surface pyrolysis model for 'none' C thermalBaffle 2D thermal baffle C thermalBaffleModel C KirchhoffShell Vibration-shell finite-area model C regionFaModel Base class for area region models C thermalShell C thermalShellModel Intermediate class for thermal-shell finite-area models C vibrationShellModel Intermediate class for vibration-shell finite-area models C regionModel Base class for region models C regionModel1D Base class for 1-D region models C regionModelFunctionObject Region model function object base class C regionModelFunctionObjectList List of cloud function objects C singleLayerRegion Base class for single layer region models C surfaceFilmModel Base class for surface film models N AveragingMethods C Basic Basic lagrangian averaging procedure C Dual Dual-mesh lagrangian averaging procedure C Moment Moment lagrangian averaging procedure N CorrectionLimitingMethods C absolute Correction limiting method based on the absolute particle velocity C noCorrectionLimiting Place holder for the 'none' option C relative Correction limiting method based on the relative particle velocity N DampingModels C NoDamping Place holder for the 'none' option C Relaxation Relaxation collisional damping model N IsotropyModels C NoIsotropy Place holder for the 'none' option C Stochastic Stochastic return-to-isotropy model N PackingModels C Explicit Explicit model for applying an inter-particle stress to the particles C Implicit Implicit model for applying an inter-particle stress to the particles C NoPacking N ParticleStressModels C exponential Exponential inter-particle stress model of the same form as used in twoPhaseEulerFoam C HarrisCrighton Inter-particle stress model of Harris and Crighton C Lun Inter-particle stress model of Lun et al N TimeScaleModels C equilibrium Equlibrium model for the time scale over which properties of a dispersed phase tend towards the mean value C isotropic Model for the time scale over which the velocity field of a dispersed phase tends towards an isotropic distribution C nonEquilibrium Non-Equlibrium model for the time scale over which properties of a dispersed phase tend towards the mean value N energyScalingFunctions C doubleSigmoid C noScaling C shifted C shiftedForce C sigmoid N pairPotentials C azizChen Reference: C coulomb C dampedCoulomb C exponentialRepulsion C lennardJones C maitlandSmith Reference: C noInteraction N tetherPotentials C harmonicSpring C pitchForkRing C restrainedHarmonicSpring N blockEdges A namespace for various blockEdge types C arcEdge A blockEdge defined as an arc of a circle C bezier Nth order bezier curve edge. Only interior control points should be specified. The outer points are taken as start and end. Note that the calculation of each point takes 0(N^2) time, where N is the number of control points. This edge type shouldn't therefore be used for finely discretised line data; polyLine or similar will be more appropriate for such cases. Beziers are useful for simple curved shapes such as aerofoils, or when you want an edge to match a specific direction at one, or both, or its endpoints. In comparison with BSplines, the grading of bezier edges should be smoother, and the code is much simpler. The algorithmic order is worse, however, and the edge will not follow the control points as closely C BSplineEdge A blockEdge interface for B-splines C lineEdge A straight edge between the start point and the end point C polyLineEdge A blockEdge defined in terms of a series of straight line segments C projectCurveEdge Defines the edge from the projection onto a surface (single surface) or intersection of two surfaces C projectEdge Defines the edge from the projection onto a surface (single surface) or intersection of two surfaces C splineEdge A blockEdge interface for Catmull-Rom splines N blockFaces C projectFace Projects the given set of face points onto the selected surface of the geometry provided as a searchableSurfaces object N blocks C namedBlock Gives name to a block N blockVertices C namedVertex Gives name to a vertex C pointVertex C projectVertex Projects the vertex onto the selected surfacees of the geometry provided as a searchableSurfaces object N extrudeModels C cyclicSector Extrudes a sector C linearDirection Extrudes by transforming points in a specified direction by the given distance C linearNormal Extrudes by transforming points normal to the surface by a given distance C linearRadial Extrudes by transforming radially from the surface C offsetSurface Extrudes by interpolating points from one surface to the other. Surfaces have to be topologically identical i.e. one has to be an offsetted version of the other C plane Extrudes by transforming points normal to the surface by 1 layer over a given distance C polyline Extrudes by transforming points along a polyline provided as a series of points and edge segments. Supports all blockMesh edge types, e.g. line, arc, spline. The surface points are rotated to follow the path C radial Extrudes radially according to the Function1 description C sector Extrudes by rotating a surface around an axis C sigmaRadial Extrudes into sphere with grading according to pressure (atmospherics) C wedge Extrudes by rotating a surface symmetrically around axis by 1 layer N coordSetWriters C abaqusWriter Write coordSet(s) as Abaqus point fields C csvWriter Write coordSet(s) in csv format C ensightWriter C gltfWriter A coordSet(s) writer in glTF v2 format, which is particularly useful for writing track data C gnuplotWriter A coordSet(s) writer in gnuplot format C nastranWriter Write coordSet(s) as Nastran plot lines. Does not do field data C nullWriter A coordSet(s) writer with suppressed output C rawWriter A coordSet(s) in raw format C vtkWriter C xmgraceWriter Write coordSet(s) in xmgrace format N graphWriters C gnuplotWriter Output in gnuplot (http://www.gnuplot.info ) format C rawWriter A raw xy graph output C xmgraceWriter Output and agr file for xmgrace (http://plasma-gate.weizmann.ac.il/Grace/ ) N processorLODs C box Creates the parallel distribution map by describing the source and target objects using box shapes C cellBox Creates the parallel distribution map by describing the source and target objects using box shapes C faceBox Creates the parallel distribution map by describing the source and target objects using box shapes N solidBodyMotionFunctions Namespace for solid-body motions C axisRotationMotion Constant velocity rotation around CoG. Similar to rotatingMotion but motion specified as rotation vector C drivenLinearMotion Variable velocity displacement. The velocity is read from a uniformVectorField from the time registry with the name CofGvelocity C linearMotion SolidBodyMotionFvMesh 6DoF motion function. Constant velocity displacement C multiMotion Combination of SolidBodyMotionFvMesh 6DoF motion functions C oscillatingRotatingMotion SolidBodyMotionFvMesh 6DoF motion function. Oscillating rotation C rotatingMotion SolidBodyMotionFvMesh 6DoF motion function C SDA Ship design analysis (SDA ) 3DoF motion function C tabulated6DoFMotion Tabulated 6DoF motion function N BitOps Various bit-wise operations and adaptor methods for containers that are somewhat similar to bitSet (eg, boolList , labelHashSet ) C bitInfo An (unsigned) integral type adapter, for output of bit values N HashSetOps Various operations for HashSet C plusEqOp Combine HashSet operation. Equivalent to 'a |= b' N HashTableOps Various operations for HashTable C plusEqOp Combine HashTable operation. Equivalent to 'a += b' N ListOps Various utility functions to work on Lists C appendEqOp List helper to append y elements onto the end of x C uniqueEqOp List helper to append y unique elements onto the end of x C unionEqOp List helper to add y unique elements to x C less A list compare binary predicate for normal sort C greater A list compare binary predicate for reverse sort N ListPolicy Additional compile-time controls of List behaviour C short_length Number of items before requiring line-breaks in the list output C no_linebreak Can suppress additional line breaks separate ASCII data content when the data elements are primitives, or contiguous C no_linebreak< keyType > Suppress line-breaks for keyType C no_linebreak< word > Suppress line-breaks for word C no_linebreak< wordRe > Suppress line-breaks for wordRe N functionEntries Namespace for containing a functionEntry C calcEntry Uses dynamic compilation to provide calculating functionality for entering dictionary entries C codeStream Dictionary entry that contains C++ OpenFOAM code that is compiled to generate the entry itself. So C evalEntry Uses expressions::fieldExprDriver to evaluate mathematical expressions with scalars, vectors etc C ifEntry Conditional parsing of dictionary entries C ifeqEntry Conditional parsing of dictionary entries C includeEntry A dictionary directive for including a file, expects a single string to follow C sincludeEntry A dictionary directive for conditionally including a file, expects a single string to follow C includeEtcEntry A dictionary directive for including a file found using the Foam::findEtcFile() mechanism C sincludeEtcEntry A dictionary directive for conditionally including an etc file, expects a single string to follow C includeFuncEntry Specify a functionObject dictionary file to include, expects the functionObject name to follow with option arguments (without quotes) C inputMode Specify the global input mode when reading further dictionaries, expects a single word to follow C inputModeDefault Temporarily change inputMode to protect for the following entry C inputModeMerge Temporarily change inputMode to merge for the following entry C inputModeOverwrite Temporarily change inputMode to overwrite for the following entry C inputModeWarn Temporarily change inputMode to warn for the following entry C inputModeError Temporarily change inputMode to error for the following entry C messageDirective Expands string content and reports as a message on stderr C removeEntry Remove a dictionary entry C wordDirective Converts/expands string content to a word. This can be useful for composition of names N FlatOutput Various output adaptors, principally to output a list of items on a single line C OutputAdaptor An output adaptor with a write method and an Ostream operator C Decorators List decorators with open, close and separator characters C BareComma Surround with '\0' and '\0' separate with ',' C BareSpace Surround with '\0' and '\0' separate with ' ' C BraceComma Surround with '{' and '}' separate with ',' C BraceSpace Surround with '{' and '}' separate with ' ' C ParenComma Surround with '(' and ')' separate with ',' C ParenSpace Surround with '(' and ')' separate with ' ' C PointyComma Surround with '<' and '>' separate with ',' C PointySpace Surround with '<' and '>' separate with ' ' C SquareComma Surround with '[' and ']' separate with ',' C SquareSpace Surround with '[' and ']' separate with ' ' N PstreamUtils Interface handling for UPstream/Pstream/MPI etc C Cast N fileOperations Namespace for implementations of a fileOperation C collatedFileOperation Version of masterUncollatedFileOperation that collates regIOobjects into a container in the processors/ subdirectory C fileOperationInitialise_collated A fileOperation initialiser for collated file handlers. Requires threading for non-zero maxThreadFileBufferSize C hostCollatedFileOperation Version of collatedFileOperation with multiple read/write ranks C dummyFileOperation Dummy fileOperation , to be used as a placeholder for interfaces taking a reference to a fileOperation . Will mostly behave like a no-op, but at the moment no guarantees of any particular behaviour other than good() returning false C fileOperationInitialise C fileOperationInitialise_unthreaded A fileOperation initialiser for unthreaded file handlers C masterUncollatedFileOperation FileOperations that performs all file operations on the master processor. Requires the calls to be parallel synchronised! C mkDirOp C chModOp C modeOp C typeOp C existsOp C isDirOp C isFileOp C fileSizeOp C lastModifiedOp C highResLastModifiedOp C mvBakOp C rmOp C rmDirOp C cpOp C lnOp C mvOp C fileOrNullOp C readDirOp C hostUncollatedFileOperation Version of masterUncollated with host-based IO ranks C uncollatedFileOperation FileOperation that assumes file operations are local N exprTools Helper methods for creating expressions C expressionEntry Convert dictionary entry to a stringified expression C boolEntry Expression representation of a bool : (false/true) C dimensionedScalarEntry Create an expression string from a dimensionedScalar as its value C dimensionedVectorEntry Create an expression string from a dimensionedVector as its value C dimensionedTensorEntry Create an expression string from a dimensionedTensor as its value C dimensionedSymmTensorEntry Create an expression string from a dimensionedSymmTensor as its value C dimensionedSphericalTensorEntry Create an expression string from a dimensionedSphericalTensor as its value C stringEntry Creates an expression from a string (removing surrounding quotes) C vectorEntry Create an expression string from a vector C tensorEntry Create an expression string from a tensor C symmTensorEntry Create an expression string from a symmTensor C sphericalTensorEntry Create an expression string from a sphericalTensor N cut C uniformOp C noOp C areaOp C volumeOp C areaIntegrateOp C volumeIntegrateOp C listOp C result Result class C appendOp C opAddResult Trait to determine the result of the addition of two operations C opAddResult< Op, Op > C opAddResult< noOp, noOp > C opAddResult< noOp, Op > C opAddResult< Op, noOp > N coordinateRotations Namespace for coordinate system rotations C axes A coordinateRotation specified using global axes C axisAngle A coordinateRotation specified by a rotation axis and a rotation angle about that axis C cylindrical A special purpose coordinateRotation that is generally for use in combination with a cylindricalCS when only the orientation of the local Z-axis is relevant C euler A coordinateRotation defined in the z-x-z (intrinsic) Euler convention C identity An identity coordinateRotation C specified An user-specified coordinateRotation , primarily to be used internally within coding when the rotation matrix is already known but needs to be wrapped as a coordinateRotation for use in a coordinate system C starcd A coordinateRotation defined by the STAR-CD convention N coordSystem Namespace for coordinate systems C cartesian A Cartesian coordinate system C cylindrical A cylindrical coordinate system (r-theta-z). The coordinate system angle theta is always in radians C indirect A coordinate system forward to a global coordinate system that is normally provided by the constant/coordinateSystems file N predicates Constant predicate types C always Unary and binary predicates that always return true, useful for templating C never Unary and binary predicates that never return true, useful for templating C scalars A list of unary predicates (tests) on scalars. Includes a number of standard comparison predicates (eg, "less", "greater", ...) N stringListOps Various utility functions to work on lists of strings C foundOp Functor to determine if a string exists in a list of strings N parsing Collection of static functions and data related to parsing and an isolated namespace for lexers, parsers, scanners C genericRagelLemonDriver Generic interface code for Ragel/Lemon combination Subclasses should implement one or more process() methods N stringOps Collection of static functions for various string-related operations C natural_sort Encapsulation of natural order sorting for algorithms C reverse Reverse natural sorting C list_less A UList compare binary predicate for natural sort C list_greater A Ulist compare binary predicate for reverse natural sort N objectives C objectivePartialVolume C objectiveTopOSolidVolume Objective quantifying the difference between the volume occupied by solid in topology optimisation and a target percentage; the latter can change throughout the optimisation cycles through a Function1 C objectiveTopOVolume Objective quantifying the difference between the volume occupied by fluid in topology optimisation and a target percentage; the latter can change throughout the optimisation cycles through a Function1 C objectiveFlowRate Minimize/maximize flow rate through a given set of patches C objectiveFlowRatePartition Split inlet flow rate to given percentages at the prescribed outlet patches C objectiveForce C objectiveMoment C objectiveNutSqr Objective qualitatively quantifying noise through the integral of the squared turbulent viscosity over specified cellZones. Requires the adjoint to the turbulence model to be incorporated into the optimisation loop C objectivePowerDissipation Computes and minimizes the power dissipation within given cellZones. In the absence of significant viscous stresses on the "inlet" and "outlet" of the cellZones, this value is equal to the volume flow rate-weigthed total pressure losses (see also objectivePtLosses ) within th cellZones C objectivePtLosses C objectiveUniformityCellZone Computes and minimizes (half) the variance of the velocity distribution in a given set of cellZones C objectiveUniformityPatch Computes and minimizes (half) the variance of the velocity distribution in a given set of patches N incompressibleAdjoint Namespace for incompressible adjoint turbulence models N adjointRASModels C adjointkOmegaSST Continuous adjoint to the kOmegaSST turbulence model for incompressible flows C adjointLaminar Dummy turbulence model for a laminar incompressible flow. Can also be used when the "frozen turbulence" assumption is employed C adjointSpalartAllmaras Continuous adjoint to the Spalart-Allmaras one-eqn mixing-length model for incompressible flows C adjointRASModel Abstract base class for incompressible turbulence models C adjointTurbulenceModel Abstract base class for incompressible adjoint turbulence models (RAS, LES and laminar) N incompressible N RASVariables C kEpsilon C kOmegaSST C laminar C LaunderSharmaKE C SpalartAllmaras N RASModels C kkLOmega Low Reynolds-number k-kl-omega turbulence model for incompressible flows C LamBremhorstKE Lam and Bremhorst low-Reynolds number k-epsilon turbulence model for incompressible flows C LienCubicKE Lien cubic non-linear low-Reynolds k-epsilon turbulence models for incompressible flows C LienLeschziner Lien and Leschziner low-Reynolds number k-epsilon turbulence model for incompressible flows C qZeta Gibson and Dafa'Alla's q-zeta two-equation low-Re turbulence model for incompressible flows C ShihQuadraticKE Shih's quadratic algebraic Reynolds stress k-epsilon turbulence model for incompressible flows C RASModelVariables Abstract base class for objective functions. No point in making this runTime selectable since its children will have different constructors C alphatJayatillekeWallFunctionFvPatchScalarField This boundary condition provides a kinematic turbulent thermal conductivity for using wall functions, using the Jayatilleke 'P' function N POSIX OS-specific functions implemented in POSIX C directoryIterator A simple directory contents iterator N cellCellStencils C cellVolumeWeight Volume-weighted interpolation stencil C inverseDistance Inverse-distance-weighted interpolation stencil C interpolatedDonorSet Data for a set of interpolated/donor set C leastSquares Least-squares-weighted interpolation stencil C trackingInverseDistance Inverse-distance-weighted interpolation stencil N decompositionConstraints C geometric Keep faces together based on geometric considerations from a list of topoSetFaceSource . The faces selected (inside) of each source are to be kept together during the decomposition C preserveBaffles Detects baffles and keeps owner and neighbour on same processor C preserveFaceZones Constraint to keep/move owner and neighbour of faceZone onto same processor C preservePatches Constraint to keep owner and neighbour of (cyclic) patch on same processor C refinementHistory Constraint to keep all cells originating from refining the same cell onto the same processor. Reads polyMesh/refinementHistory C singleProcessorFaceSets Constraint to keep all cells connected to face or point of faceSet on a single processor N multiphaseEuler N diameterModels C constant Constant dispersed-phase particle diameter model C isothermal Isothermal dispersed-phase particle diameter model N dragModels C blended Blends two drag models based on the phase fractions to handle phase-inversion C Ergun H, Enwald, E. Peirano, A-E Almstedt 'Eulerian Two-Phase Flow Theory Applied to Fluidization' Int. J. Multiphase Flow, Vol. 22, Suppl, pp. 21-66 (1996) Eq. 104, p. 42 C Gibilaro H, Enwald, E. Peirano, A-E Almstedt 'Eulerian Two-Phase Flow Theory Applied to Fluidization' Int. J. Multiphase Flow, Vol. 22, Suppl, pp. 21-66 (1996) Eq. 106, p. 43 C GidaspowErgunWenYu D. Gidaspow, Multiphase flow and fluidization, Academic Press, New York, 1994 C GidaspowSchillerNaumann H, Enwald, E. Peirano, A-E Almstedt 'Eulerian Two-Phase Flow Theory Applied to Fluidization' Int. J. Multiphase Flow, Vol. 22, Suppl, pp. 21-66 (1996) Eq. 86-87, p. 40 C interface Drag between phase separated by a VoF resolved interface C SchillerNaumann C SyamlalOBrien Syamlal, M., Rogers, W. and O'Brien, T. J. (1993) MFIX documentation, Theory Guide. Technical Note DOE/METC-94/1004. Morgantown, West Virginia, USA C WenYu H, Enwald, E. Peirano, A-E Almstedt 'Eulerian Two-Phase Flow Theory Applied to Fluidization' Int. J. Multiphase Flow, Vol. 22, Suppl, pp. 21-66 (1996) Eq. 86-87, p. 40 N heatTransferModels C RanzMarshall C alphaContactAngleFvPatchScalarField C interfaceThetaProps C diameterModel Abstract base-class for dispersed-phase particle diameter models C dragModel C heatTransferModel N multiphaseInter N surfaceTensionModels C constantSurfaceTensionCoefficient C interfaceCompositionModel C surfaceTensionModel C multiphaseSystem C phaseModel N porousModels C VollerPrakash Porous model to apply a porous media on a solid phase N meltingEvaporationModels C diffusionGasEvaporation Gas diffusion based evaporation/condensation mass transfer model C interfaceHeatResistance Interface Heat Resistance type of condensation/saturation model using spread source distribution following: C interfaceOxideRate The interfaceOxideRate mDotOxide), which is a local function of the volume fraction of reducing agent (alpha), temperature (T) and oxide-inclusion density (chi) C kineticGasEvaporation Considering the Hertz Knudsen formula, which gives the evaporation-condensation flux based on the kinetic theory for flat interface: C Lee Mass transfer Lee model. Simple model driven by field value difference as: N blendingMethods C hyperbolic C linear C noBlending N reactingMultiphaseEuler N surfaceTensionModels C constantSurfaceTensionCoefficient C alphaContactAngleFvPatchScalarField C interfaceThetaProps C surfaceTensionModel N compressible N RASModels C alphatFilmWallFunctionFvPatchScalarField This boundary condition provides a turbulent thermal diffusivity condition when using wall functions, for use with surface film models. This condition varies from the standard wall function by taking into account any mass released from the film model C nutkFilmWallFunctionFvPatchScalarField This boundary condition provides a turbulent viscosity condition when using wall functions, based on turbulence kinetic energy, for use with surface film models C PDRkEpsilon Standard k-epsilon turbulence model with additional source terms corresponding to PDR basic drag model (basic.H ) C alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField A simple alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField C alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField This boundary condition provides a thermal wall function for turbulent thermal diffusivity (usuallyalphat) based on the Jayatilleke model for the Eulerian multiphase solvers C alphatPhaseChangeWallFunctionFvPatchScalarField Abstract base-class for all alphatWallFunctions supporting phase-change C alphatWallBoilingWallFunctionFvPatchScalarField A thermal wall function for simulation of boiling wall C thermalShellFvPatchScalarField This boundary condition provides a coupled temperature condition between a primary region (3D mesh) and a thermal shell model (2D mesh) C thermalBaffleFvPatchScalarField This boundary condition provides a coupled temperature condition between multiple mesh regions C convectiveHeatTransferFvPatchScalarField This boundary condition provides a convective heat transfer coefficient condition C thermalBaffle1DFvPatchScalarField This BC solves a steady 1D thermal baffle C turbulentTemperatureCoupledBaffleMixedFvPatchScalarField Mixed boundary condition for temperature, to be used for heat-transfer on back-to-back baffles. Optional thin thermal layer resistances can be specified through thicknessLayers and kappaLayers entries C turbulentTemperatureRadCoupledMixedFvPatchScalarField Mixed boundary condition for temperature and radiation heat transfer, suitable for multiregion cases. The optional specification of thin thermal layer resistances can be made using the entries thicknessLayers and kappaLayers C alphatJayatillekeWallFunctionFvPatchScalarField This boundary condition provides a thermal wall function for turbulent thermal diffusivity (usuallyalphat) based on the Jayatilleke model C alphatWallFunctionFvPatchScalarField This boundary condition provides a turbulent thermal diffusivity condition when using wall functions C turbulentTemperatureTwoPhaseRadCoupledMixedFvPatchScalarField Mixed boundary condition for temperature and radiation heat transfer to be used for in multiregion cases with two phase Euler system N wallBoilingModels N CHFModels C Zuber A critical heat flux (CHF) correlation model based on Zuber (1958) for boiling flows C HuaXu A critical heat flux (CHF) sub-cooling correlation model based on Hua-Xu (2000) for boiling flows C Tatsumoto A critical heat flux (CHF) sub-cooling correlation model C Jeschar N departureDiameterModels C KocamustafaogullariIshii A correlation for bubble departure diameter modelling based on Kocamustafaogullari-Ishii (1983) for boiling flows C TolubinskiKostanchuk A correlation for bubble departure diameter modelling based on Tolubinski-Kostanchuk (1970) for boiling flows N departureFrequencyModels C Cole A correlation for bubble departure frequency modelling based on Cole (1960) for boiling flows N filmBoilingModels C BreenWestwater Boiling film correlation. A correlation for boiling film modelling based on Breen & Westwater (1965) for boiling flows C Bromley A correlation for boiling film modelling based on Bromley (1950) for boiling flows N LeidenfrostModels C Spiegler A model for Leidenfrost effects based on Spiegler et al. (1963) for boiling flows N nucleateFluxModels C exponential Nucleate flux sub-cooling correlation C Kutadeladze Nucleate flux sub-cooling correlation N nucleationSiteModels C LemmertChawla A model for nucleation site density based on Lemmert-Chawla (1977) function and Egorov-Menter (2004) correlation for boiling flows N partitioningModels C cosine A cosine model for wall heat flux partitioning based on Tentner et al. (2006) for boiling flows C Lavieville A model for wall heat flux partitioning based on Lavieville et al. (2006) for boiling flows C linear A linear model for wall heat flux partitioning based on Ioilev et al. (2007) for boiling flows C phaseFraction Wall heat-flux partitioned according to the phase volume fraction N TDNBModels C Schroeder A model for departure from nucleation boiling based on Schroeder-Richter and Bartsch (1994) for boiling flows C Shirai Temperature of departure from nulceate boiling correlation C CHFModel Base class for critical heat flux (CHF) correlation models for boiling flows C CHFSubCoolModel C departureDiameterModel Base class for bubble departure diameter models for boiling flows C departureFrequencyModel Base class for bubble departure frequency models for boiling flows C filmBoilingModel C LeidenfrostModel Base class for Leidenfrost-effect models C MHFModel C nucleateFluxModel Base class for nucleation flux models C nucleationSiteModel Base class for nucleation site density models C partitioningModel Base class for wall heat flux partitioning models C TDNBModel Base class for departure from nucleation boiling models N diameterModels N binaryBreakupModels C LehrMilliesMewes Model of Lehr et al. (2002). The breakup rate is calculated by C LuoSvendsen Model of Luo and Svendsen (1996). The breakup rate is calculated by C powerLawUniformBinary Powerlaw kernel with a uniform daughter size distribution. Used for verification and validation of the binary breakup formulation implemented in the populationBalanceModel class N breakupModels C exponential Exponential kernel. Used for verification and validation of the breakup formulation implemented in the populationBalanceModel class C LaakkonenAlopaeusAittamaa Model of Laakkonen et al. (2006). The total breakup rate is calculated by C powerLaw Powerlaw kernel. Used for verification and validation of the breakup formulation implemented in the populationBalanceModel class N coalescenceModels C constantCoalescence Constant coalescence kernel. Used for verification and validation of the coalescence formulation implemented in the populationBalanceModel class C CoulaloglouTavlaridesCoalescence Model of Coulaloglou and Tavlarides (1977). The coalescence rate is calculated by C hydrodynamic Hydrodynamic kernel. Used for verification and validation of the coalescence formulation implemented in the populationBalanceModel class C LehrMilliesMewesCoalescence Model of Lehr et al. (2002). The coalescence rate is calculated by C Luo Model of Luo (1993). The coalescence rate is calculated by C PrinceBlanch Model of Prince and Blanch (1990). The coalescence rate is calculated by N daughterSizeDistributionModels C LaakkonenAlopaeusAittamaaDsd Daughter size distribution model used by Laakkonen et al. (2006). Note that it must be multiplied by the number of daughter particles (2). Also, the coefficient C4 needs to be set to the value of 2 as to ensure number and mass conservation following Kumar and Ramkrishna (1996). Also the internal coordinate was changed to particle volume, which gives C uniformBinary Uniform binary daughter size distribution. Used for verification and validation of the breakup formulation implemented in the populationBalanceModel class N driftModels C constantDrift Constant drift rate within all classes. Used for verification and validation of the drift formulation implemented in the populationBalanceModel class. Rate is calculated from fvOptions mass source C densityChangeDrift Drift rate induced by changes in density C phaseChange Drift induced by interfacial phase change. By default phase change mass flux is distributed between sizeGroups of each velocityGroup with phase change based on interfacial area of each size group N nucleationModels C constantNucleation Constant nucleation rate within all classes. Used for verification and validation of the nucleation formulation implemented in the populationBalanceModel class. Rate is calculated from fvOptions mass source C wallBoiling Wall-boiling model which requires a velocityGroup (i.e. phase) to be specified in which the nucleation occurs. This setting must be consistent with the specifications in the alphatWallBoilingWallFunction. If the departure-diameter lies outside the diameter-range given by the sizeGroups of the corresponding velocityGroup , the solver will give a warning and the nucleation rate will be set to zero N IATEsources C dummy C phaseChange Phase-change IATE source C randomCoalescence Random coalescence IATE source as defined in paper: C turbulentBreakUp Turbulence-induced break-up IATE source as defined in paper: C wakeEntrainmentCoalescence Bubble coalescence due to wake entrainment IATE source as defined in paper: C wallBoiling Wall-boiling IATE source C constant Constant dispersed-phase particle diameter model C isothermal Isothermal dispersed-phase particle diameter model C linearTsub C sizeGroup This class represents a single sizeGroup belonging to a velocityGroup . The main property of a sizeGroup is its representative diameter. The corresponding volScalarField f<number>.<phaseName>.<populationBalanceName> gives the volume fraction of the sizeGroup such that all sizeGroup fractions over a velocityGroup must sum to unity. The field is either read from the startTime directory if present or constructed from a reference field called f.<phaseName>.<populationBalanceName> where the boundary condition types must be specified. All field and boundary condition values are reset to match the "value" given in the sizeGroup subdictionary C iNew Return a pointer to a new sizeGroup created on freestore C velocityGroup This diameterModel is intended for use with a populationBalanceModel in order to simulate polydispersed bubbly or particulate flows. It can hold any number of sizeGroups from which the Sauter mean diameter is calculated. It can also be used as a diameterModel without a populationBalance and would then behave like a constantDiameter model. In this case, some arbitrary name must be entered for the populationBalance keyword C binaryBreakupModel Base class for binary breakup models which give the breakup rate between a sizeGroup pair directly, without an explicit expression for the daughter size distribution C iNew Class used for the read-construction of C breakupModel Base class for breakup models which give a total breakup rate and a separate daughter size distribution function C iNew Class used for the read-construction of C coalescenceModel Base class for coalescence models C iNew Class used for the read-construction of C daughterSizeDistributionModel Base class for daughter size distribution models C driftModel Base class for drift models C iNew Class used for the read-construction of C nucleationModel Base class for nucleation models C iNew Class used for the read-construction of C populationBalanceModel Class that solves the univariate population balance equation by means of a class method (also called sectional or discrete method). The internal coordinate is set to the particle volume, so the equation is based on a transport equation of the volume-based number density function. The discretization is done using the fixed pivot technique of Kumar and Ramkrishna (1996). The source terms are written in a way that particle number and mass are preserved. Coalescence (aggregation), breakup, drift (growth and surface loss) as well as nucleation are supported. For the discrete breakup term two recipes are available, depending on the model choice. For models which state a total breakup rate and a separate daughter size distribution function, the formulation of Kumar and Ramkrishna (1996) is applied which is applicable for binary and multiple breakup events. The second formulation is given by Liao et al. (2018). It is useful for binary breakup models which give the breakup rate between a sizeGroup pair directly, without an explicit expression for the daughter size distribution. The drift term is implemented using a finite difference upwind scheme. Although it is diffusive, it ensures a stable and number-conservative solution C iNew Return a pointer to a new populationBalanceModel object created on C IATE IATE (Interfacial Area Transport Equation) bubble diameter model C IATEsource IATE (Interfacial Area Transport Equation) bubble diameter model run-time selectable sources C iNew Class used for the read-construction of N interfaceCompositionModels C Henry Henry 's law for gas solubility in liquid. The concentration of a dissolved species in the liquid is proportional to its partial pressure in the gas. A dimensionless solubility, C NonRandomTwoLiquid Non ideal law for the mixing of two species. A separate composition model is given for each species. The composition of a species is equal to the value given by the model, scaled by the species fraction in the bulk of the other phase, and multiplied by the activity coefficient for that species. The gas behaviour is assumed ideal; i.e. the fugacity coefficient is taken as equal to 1 C Raoult Raoult 's law of ideal mixing. A separate composition model is given for each species. The composition of a species is equal to the value given by the model scaled by the species fraction in the bulk of the other phase C Saturated Model which uses a saturation pressure model for a single species to calculate the interface composition N massTransferModels C Frossling Frossling correlation for turbulent mass transfer from the surface of a sphere to the surrounding fluid C sphericalMassTransfer Model which applies an analytical solution for mass transfer from the surface of a sphere to the fluid within the sphere N aspectRatioModels C constantAspectRatio Constant value aspect ratio model C TomiyamaAspectRatio Aspect ratio model of Tomiyama C VakhrushevEfremov Aspect ratio model of Vakhrushev and Efremov C Wellek Aspect ratio model of Wellek et al N dragModels C AttouFerschneider Attou and Ferschneider's Drag model for film flow through packed beds. The implementation follows the description of Gunjal and Ranade, who, in the reference below, formulate the model in more convenient terms C Beetstra Drag model of Beetstra et al. for monodisperse gas-particle flows obtained with direct numerical simulations with the Lattice-Boltzmann method and accounting for the effect of particle ensembles C Ergun Reference: C Gibilaro Reference: C GidaspowErgunWenYu Gidaspow, Ergun , Wen and Yu drag model C GidaspowSchillerNaumann Gidaspow, Schiller and Naumann drag model C IshiiZuber Ishii and Zuber (1979) drag model for dense dispersed bubbly flows C Lain Drag model of Lain et al C SchillerNaumann Schiller and Naumann drag model for dispersed bubbly flows C segregated Segregated drag model for use in regions with no obvious dispersed phase C SyamlalOBrien Reference: C Tenneti Drag model of Tenneti et al. for monodisperse gas-particle flows obtained with particle-resolved direct numerical simulations and accounting for the effect of particle ensembles C TomiyamaAnalytic Analytical drag model of Tomiyama et al C TomiyamaCorrelated Correlation of Tomiyama et al C TomiyamaKataokaZunSakaguchi Drag model for gas-liquid system of Tomiyama et al C WenYu Wen and Yu drag model N heatTransferModels C constantNuHeatTransfer Model which applies a user provided constant Nusselt number for interfacial heat transfer C RanzMarshall Ranz-Marshall correlation for turbulent heat transfer from the surface of a sphere to the surrounding fluid C sphericalHeatTransfer Model which applies an analytical solution for heat transfer from the surface of a sphere to the fluid within the sphere N liftModels C constantLiftCoefficient Constant coefficient lift model C LegendreMagnaudet Lift model of Legendre and Magnaudet C Moraga Lift model of Moraga et al C noLift C TomiyamaLift Lift model of Tomiyama et al C wallDamped N phaseTransferModels C deposition Phase transfer model representing change from a dispersed phase to a film as a result of deposition onto a third phase N swarmCorrections C noSwarm C TomiyamaSwarm Swarm correction of Tomiyama et al N turbulentDispersionModels C Burns Turbulent dispersion model of Burns et al C constantTurbulentDispersionCoefficient Constant coefficient turbulent dispersion model C Gosman Turbulent dispersion model of Gosman et al C LopezDeBertodano Lopez de Bertodano (1992) turbulent dispersion model C noTurbulentDispersion N virtualMassModels C constantVirtualMassCoefficient Constant coefficient virtual mass model C Lamb Virtual mass model of Lamb C noVirtualMass N wallDampingModels C cosine C interpolated C linear C noWallDamping C sine N wallLubricationModels C Antal Wall lubrication model of Antal et al C Frank Wall lubrication model of Frank C noWallLubrication C TomiyamaWallLubrication Wall lubrication model of Tomiyama N saturationModels C Antoine Antoine equation for the vapour pressure C AntoineExtended Extended Antoine equation for the vapour pressure C ArdenBuck ArdenBuck equation for the vapour pressure of moist air C constantSaturationConditions Constant saturation pressure and temperature C function1 Saturation vapour temperature in terms of the vapour pressure (in Pa). The saturation temperature in Kelvins is specified as a Foam::Function1 type, to enable use of, e.g. constant, polynomial, table values C polynomial Polynomial equation for the saturation vapour temperature in terms of the vapour pressure (in Pa) N kineticTheoryModels N conductivityModels C Gidaspow C HrenyaSinclair C Syamlal N frictionalStressModels C JohnsonJackson C JohnsonJacksonSchaeffer C Schaeffer N granularPressureModels C Lun C SyamlalRogersOBrien N radialModels C CarnahanStarling C LunSavage C SinclairJackson N viscosityModels C Gidaspow C HrenyaSinclair C Syamlal C conductivityModel C frictionalStressModel C granularPressureModel C radialModel C noneViscosity C viscosityModel N noiseModels C pointNoise Perform noise analysis on point-based pressure data C surfaceNoise Perform noise analysis on surface-based pressure data N windowModels C Hanning Hanning window C uniform A window that applies uniform scaling N filmSeparationModels A namespace for various filmSeparation model implementations C FriedrichModel Computes film-separation properties from sharp edges for full separation (Friedrich et al., 2008) and partial separation (Zhang et al., 2018) C OwenRyleyModel Computes film-separation properties from round edges for full separation (Owen & Ryley, 1983). The model assesses the film curvature based on the mesh geometry and flow field, and then calculates a force balance of the following form: N RBD N joints Namespace for rigid-body joints C composite Prismatic joint for translation along the specified arbitrary axis C floating Prismatic joint for translation along the specified arbitrary axis C null Null joint for the root-body C Pa Prismatic joint for translation along the specified arbitrary axis C Px Prismatic joint for translation along the x-axis C Pxyz Prismatic joint for translation in the x/y/z directions C Py Prismatic joint for translation along the y-axis C Pz Prismatic joint for translation along the x-axis C Ra Revolute joint for rotation about the specified arbitrary axis C Rs Spherical joint for rotation about the x/y/z-axes using a quaternion (Euler parameters) to avoid gimble-lock C Rx Revolute joint for rotation about the x-axis C Rxyz Spherical joint for rotation about the x/y/z-axes using Euler-angles in the order x, y, z C Ry Revolute joint for rotation about the y-axis C Ryxz Spherical joint for rotation about the x/y/z-axes using Euler-angles in the order y, x, z C Rz Revolute joint for rotation about the z-axis C Rzyx Spherical joint for rotation about the x/y/z-axes using Euler-angles in the order z, y, x N restraints Namespace for rigid-body dynamics restraints C externalForce Time-dependent external force restraint using Function1 C linearAxialAngularSpring Linear axial angular spring restraint C linearDamper Linear damper restraint. Operates in the local frame of the body C linearSpring Linear spring restraint C prescribedRotation Restraint setting angular velocity of the rigid body. Developed from the linear axial angular spring restraint C softWall Soft wall is a Damper-Linear spring restraint. Acts as a "soft" wall when the distance between 'anchor' and 'refAttachmentPt' in the wallNormal direction becomes negative C sphericalAngularDamper Spherical angular damper restraint. Operates in the local frame of the body N rigidBodySolvers C CrankNicolson Crank-Nicolson 2nd-order time-integrator for 6DoF solid-body motion C Newmark Newmark 2nd-order time-integrator for 6DoF solid-body motion C symplectic Symplectic 2nd-order explicit time-integrator for rigid-body motion C compositeBody C cuboid C jointBody C masslessBody C rigidBody C sphere C subBody C joint Abstract base-class for all rigid-body joints C XSvc Joint state returned by jcalc C iNew C restraint Base class for defining restraints for rigid-body dynamics C rigidBodyInertia C rigidBodyModel Basic rigid-body model representing a system of rigid-bodies connected by 1-6 DoF joints C rigidBodyModelState Holds the motion state of rigid-body model C rigidBodyMotion Six degree of freedom motion for a rigid body C rigidBodySolver N sixDoFRigidBodyMotionConstraints Namespace for six DoF motion constraints C axis This constraint imposes an orientation limitation where bodies are restricted to rotate only around a fixed axis, optionally with the inclusion of maximum and minimum rotation angle constraints C line Translation constraint on the centre of rotation: may only move along a line C orientation Orientation constraint: fixed in global space C plane Translation constraint on the centre of rotation: may only move on a plane C point Translation constraint on the centre of rotation: fixed in space N sixDoFRigidBodyMotionRestraints Namespace for six DoF motion restraints C linearAxialAngularSpring SixDoFRigidBodyMotionRestraints model. Linear axial angular spring C linearDamper SixDoFRigidBodyMotionRestraints model. Linear spring C linearSpring SixDoFRigidBodyMotionRestraints model. Linear spring C linearSpringDamper SixDoFRigidBodyMotionRestraints model. Linear Spring-Damper system C softWall SixDoFRigidBodyMotionRestraints model. Soft wall C sphericalAngularDamper SixDoFRigidBodyMotionRestraints model. Spherical angular damper C sphericalAngularSpring SixDoFRigidBodyMotionRestraints model. Spherical angular spring C tabulatedAxialAngularSpring SixDoFRigidBodyMotionRestraints model. Axial angular spring with moment values drawn from an interpolation table. Linear damping N sixDoFSolvers C CrankNicolson Crank-Nicolson 2nd-order time-integrator for 6DoF solid-body motion C Newmark Newmark 2nd-order time-integrator for 6DoF solid-body motion C symplectic Symplectic 2nd-order explicit time-integrator for 6DoF solid-body motion N surfaceWriters Namespace for surface writers C abaqusWriter A surface writer for the ABAQUS file format - both surface mesh and fields C boundaryDataWriter A surfaceWriter for outputting to a form usable for the timeVaryingMapped boundary condition. This reads the data from constant/boundaryData/<patch> directory C debugWriter A surfaceWriter for special purpose debugging. Its definition and behaviour are subject to change at any time C ensightWriter A surfaceWriter for Ensight format C foamWriter A surfaceWriter for OpenFOAM surfaces C nastranWriter A surface writer for the Nastran file format - both surface mesh and fields C nullWriter Suppresses output of geometry and fields C proxyWriter A surfaceWriter that writes the geometry via the MeshedSurfaceProxy , but which does not support any fields C rawWriter A surfaceWriter for raw output C starcdWriter A surfaceWriter for STARCD files C vtkWriter A surfaceWriter for VTK legacy (.vtk) or XML (.vtp) format C x3dWriter A surfaceWriter for X3D files N compressibilityModels Namespace for compressibility models C Chung Chung compressibility model C linear Linear compressibility model C Wallis Wallis compressibility model N chemistryReductionMethods C DAC The Dynamic Adaptive Chemistry (DAC ) method [1] simplifies the chemistry using the matrix rAB defined by (DRGEP algorithm [2]) C DRG Implementation of the Directed Relation Graph (DRG ) method C DRGEP The DRGEP algorithm [1] is based on C EFA C none C PFA Path flux analysis N chemistryTabulationMethods C ISAT Implementation of the ISAT (In-situ adaptive tabulation), for chemistry calculation C none N laminarFlameSpeedModels Namespace for laminar flame speed models C constant Constant laminar flame speed model C Gulders Laminar flame speed obtained from Gulder's correlation C GuldersEGR Laminar flame speed obtained from Gulder's correlation with EGR modelling C RaviPetersen Laminar flame speed obtained from Ravi and Petersen's correlation C SCOPE Laminar flame speed obtained from the SCOPE correlation N species C thermo N reconstruction C isoAlpha Reconstructs an interface (centre and normal vectors) consisting of isosurfaces to match the internal fluid distribution in cells. The point values (ap_) are estimated by inverse distance interpolation of the VoF (alpha) field C gradAlpha Reconstructs an interface (centre and normal vector) consisting of planes to match the internal fluid distribution in cells. The interface normals are estimated by least square gradient scheme on the VoF Field (alpha). Also known as Young method C plicRDF Reconstructs an interface (centre and normal vector) consisting of planes to match the internal fluid distribution in cells. The interface normals are estimated by least square gradient scheme on the RDF function (height). Uses the normal from the previous times step as intial guess N viscosityModels A namespace for various incompressible viscosityModel implementations C Arrhenius Arrhenius type of dependency on a given scalar field name. Most likely temperature. The expression is as follow: C BirdCarreau An incompressible Bird-Carreau non-Newtonian viscosity model C Casson An incompressible Casson non-Newtonian viscosity model C CrossPowerLaw An incompressible Cross-Power law non-Newtonian viscosity model C HerschelBulkley Herschel-Bulkley non-Newtonian viscosity model C Newtonian An incompressible Newtonian viscosity model C powerLaw Standard power-law non-Newtonian viscosity model C strainRateFunction Run-time selected strain-rate function non-Newtonian viscosity model N surfaceTensionModels C constant Uniform constant surface tension model C temperatureDependent Temperature-dependent surface tension model C liquidProperties Temperature-dependent surface tension model in which the surface tension function provided by the phase Foam::liquidProperties class is used N laminarModels N generalizedNewtonianViscosityModels A namespace for various generalized Newtonian viscosity model implementations C BirdCarreau An incompressible Bird-Carreau non-Newtonian viscosity model C Casson Casson generalized Newtonian viscosity model C CrossPowerLaw Cross-Power law generalized Newtonian viscosity model C HerschelBulkley Herschel-Bulkley generalized Newtonian viscosity model C powerLaw Standard power-law generalized Newtonian viscosity model C strainRateFunction Run-time selected strain-rate function generalized Newtonian viscosity model C generalizedNewtonian Turbulence model for shear-dependent Non-Newtonian flow C generalizedNewtonianViscosityModel An abstract base class for generalized Newtonian viscosity models C Maxwell Maxwell model for viscoelasticity using the upper-convected time derivative of the stress tensor. See http://en.wikipedia.org/wiki/Upper-convected_Maxwell_model C Stokes Turbulence model for Stokes flow N LESModels Namespace for LES SGS models C continuousGasKEqn One-equation SGS model for the gas-phase in a two-phase system supporting phase-inversion C NicenoKEqn One-equation SGS model for the continuous phase in a two-phase system including bubble-generated turbulence C SmagorinskyZhang The Smagorinsky SGS model including bubble-generated turbulence C DESModel Templated abstract base class for DES models C kOmegaSSTDDES K-omega-SST DDES turbulence model for incompressible and compressible flows C kOmegaSSTDES K-omega-SST DES turbulence model for incompressible and compressible flows C kOmegaSSTIDDES K-omega-SST IDDES turbulence model for incompressible and compressible flows C SpalartAllmarasDDES SpalartAllmaras DDES turbulence model for incompressible and compressible flows C SpalartAllmarasDES SpalartAllmarasDES DES turbulence model for incompressible and compressible flows C SpalartAllmarasIDDES SpalartAllmaras IDDES turbulence model for incompressible and compressible flows C DeardorffDiffStress Differential SGS Stress Equation Model for incompressible and compressible flows C dynamicKEqn Dynamic one equation eddy-viscosity model C dynamicLagrangian Dynamic SGS model with Lagrangian averaging C kEqn One equation eddy-viscosity model C cubeRootVolDelta C DeltaOmegaTildeDelta Delta formulation that accounts for the orientation of the vorticity vector. In "2D-regions" (i.e. xy-plane), delta is of the order max(delta_x,delta_y), so that the influence of delta_z is discarded. This can help to accelerate the transition from RANS to LES in hybrid RANS/LES simulations C IDDESDelta C maxDeltaxyz C maxDeltaxyzCubeRootLESDelta C PrandtlDelta C SLADelta Delta formulation that accounts for the orientation of the vorticity vector and a flow-sensitised function to detect 2D flow regions. Delta value is strongly reduced in these regions to accelerate the transition from RANS to LES in hybrid RANS/LES simulations C smoothDelta C deltaData Public class used by mesh-wave to propagate the delta-ratio C vanDriestDelta C LESeddyViscosity Eddy viscosity LES SGS model base class C sigma The sigma SGS model C Smagorinsky The Smagorinsky SGS model C WALE The Wall-adapting local eddy-viscosity (WALE ) SGS model N waveModels C waveAbsorptionModel C shallowWaterAbsorption C irregularWaveModel C regularWaveModel C solitaryWaveModel C waveGenerationModel C Boussinesq Boussinesq wave model C cnoidal Cnoidal wave model C Grimshaw Grimshaw wave model C irregularMultiDirectional Multi-directional irregular wave model C McCowan McCowan wave model C StokesI Stokes I wave model C StokesII Stokes II wave model C StokesV Stokes V wave model C streamFunction StreamFunction wave model N faceSelections C faceZoneSelection Select faces from faceZone C searchableSurfaceSelection Selects all (internal or coupled) faces intersecting the searchableSurface N helpTypes C helpBoundary C helpFunctionObject C helpSolver N ROMmodels A namespace for various implementations of reduced-order (ROM) field creation models C DMD Field creation model using the streaming total dynamic mode decomposition method (STDMD) N VF A namespace for various viewFactor C raySearchEngine Base class for ray search engines C voxel Ray search engine based on discretising space into uniform voxels C viewFactor2AI Computes view factors according to the double area integral (2AI) method C viewFactor2LI Computes view factors according to the double line integral (2LI) method C viewFactorHottel Computes view factors according to Hottel's crossed strings method C viewFactorModel A base class for viewFactor N PDRlegacy Legacy and transitional routines C obstacleGrouping Locations for each instance of an obstacle group N PDRobstacles Reader classes for concrete PDRsetFields obstacle types C cylinder A cylinder, selectable as cyl or cylinder C diagbeam A diagonal beam, which is cylinder-like, selectable as diag or diagbeam C cuboid A cuboid, selectable as box C wallbeam A wallbeam, selectable as wallbeam which is currently identical to a box (PDRobstacles::cuboid ) C grating A grating, selectable as grate or grating C louver Louver blowoff, selectable as louver or louvre C patch Rectangular patch, selectable as patch N implicitFunctions C composedFunctionImplicitFunction Handles multiple implicit functions and offers multiple ways to combine them C cylinderImplicitFunction Creates a infintite long cylinderImplicitFunction C ellipsoidImplicitFunction Creates an ellipsoidImplicitFunction C paraboloidImplicitFunction Creates a paraboloid C planeImplicitFunction Creates a plane C sinImplicitFunction Original code supplied by Henning Scheufler, DLR (2019) C sphereImplicitFunction Creates a sphere N tabulatedWallFunctions C general Computes U+ as a function of Reynolds number by inverting table of y+ vs U+ C SpaldingsLaw Computes U+ as a function of Reynolds number by inverting Spaldings law C tabulatedWallFunction Base class for models that generate tabulated wall function data N surfaceFeaturesExtraction Namespace for run-time selectable surface feature extraction methods C extractFromFile Run-time selectable surface feature extraction C extractFromNone Run-time selectable surface feature extraction - no extraction. Primarily useful with self-intersection methods C extractFromSurface Run-time selectable surface feature extraction - extract from surface C method Abstract base for run-time selectable surface feature extraction methods N searchableSurfaceModifiers C autoPatch C cut N PDRDragModels C basic Basic sub-grid obstacle drag model. Details supplied by J Puttock 2/7/06 N XiEqModels C basicSubGrid Basic sub-grid obstacle flame-wrinkling enhancement factor model. Details supplied by J Puttock 2/7/06 C Gulder Simple Gulder model for XiEq based on Gulders correlation with a linear correction function to give a plausible profile for XiEq C instability This is the equilibrium level of the flame wrinkling generated by instability. It is a constant (default 2.5). It is used in XiModel.H C SCOPEBlend Simple SCOPEBlendXiEq model for XiEq based on SCOPEXiEqs correlation with a linear correction function to give a plausible profile for XiEq. See SCOPELaminarFlameSpeed.H for details on the SCOPE laminar flame speed model C SCOPEXiEq Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation with a linear correction function to give a plausible profile for XiEq. See SCOPELaminarFlameSpeed.H for details on the SCOPE laminar flame speed model N XiGModels C basicSubGrid Basic sub-grid obstacle flame-wrinkling generation rate coefficient model. Details supplied by J Puttock 2/7/06 C instabilityG Flame-surface instabilityG flame-wrinkling generation rate coefficient model used in XiModel.H C KTS Simple Kolmogorov time-scale (KTS ) model for the flame-wrinling generation rate N XiModels C algebraic Simple algebraic model for Xi based on Gulders correlation with a linear correction function to give a plausible profile for Xi. See report TR/HGW/10 for details on the Weller two equations model. See XiModel.H for more details on flame wrinkling modelling C fixed Fixed value model for Xi. See XiModel.H for more details on flame wrinkling modelling C transport Simple transport model for Xi based on Gulders correlation with a linear correction function to give a plausible profile for Xi. See report TR/HGW/10 for details on the Weller two equations model. See XiModel.H for more details on flame wrinkling modelling N mixtureViscosityModels A namespace for incompressible mixtureViscosityModel implementations C BinghamPlastic Viscosity correction model for Bingham plastics C plastic Viscosity correction model for a generic power-law plastic C slurry Thomas' viscosity correction for slurry N relativeVelocityModels C general C simple N temperaturePhaseChangeTwoPhaseMixtures C constant C interfaceHeatResistance N phaseChangeTwoPhaseMixtures C Kunz Kunz cavitation model slightly modified so that the condensation term is switched off when the pressure is less than the saturation vapour pressure. This change allows the condensation term to be formulated as a coefficient multiplying (p - p_sat) so that it can be included as an implicit term in the pressure equation C Merkle Merkle cavitation model C SchnerrSauer SchnerrSauer cavitation model C atmBoundaryLayer Base class to set log-law type ground-normal inlet boundary conditions for wind velocity and turbulence quantities for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer (ABL) modelling C atmBoundaryLayerInletEpsilonFvPatchScalarField This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy dissipation rate (i.e. epsilon) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling C atmBoundaryLayerInletKFvPatchScalarField This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy (i.e. k) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling C atmBoundaryLayerInletOmegaFvPatchScalarField C atmBoundaryLayerInletVelocityFvPatchVectorField This boundary condition provides a log-law type ground-normal inlet boundary condition for the streamwise component of wind velocity (i.e. u) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling C atmTurbulentHeatFluxTemperatureFvPatchScalarField This boundary condition provides a fixed heat constraint on temperature (i.e. T) to specify temperature gradient through an input heat source which can either be specified as absolute power [W], or as flux [W/m2] C atmAlphatkWallFunctionFvPatchScalarField This boundary condition provides a wall constraint on the kinematic turbulent thermal conductivity (i.e. alphat) for atmospheric boundary layer modelling. It assumes a logarithmic distribution of the potential temperature within the first cell C atmEpsilonWallFunctionFvPatchScalarField This boundary condition provides a wall constraint on the turbulent kinetic energy dissipation rate (i.e. epsilon) and the turbulent kinetic energy production contribution (i.e. G) for atmospheric boundary layer modelling C atmNutkWallFunctionFvPatchScalarField This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy (i.e. k) for atmospheric boundary layer modelling. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition C atmNutUWallFunctionFvPatchScalarField This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on velocity (i.e. U) for atmospheric boundary layer modelling. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition C atmNutWallFunctionFvPatchScalarField This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy (i.e. k) and velocity (i.e. U) for atmospheric boundary layer modelling C atmOmegaWallFunctionFvPatchScalarField This boundary condition provides a wall constraint on the specific dissipation rate (i.e. omega) and the turbulent kinetic energy production contribution (i.e. G) for atmospheric boundary layer modelling C ChemistryCombustion Chemistry model wrapper for combustion models C combustionModel Base class for combustion models C CombustionModel Combustion models for templated thermodynamics C ThermoCombustion Thermo model wrapper for combustion models C consumptionSpeed C reactionRateFlameArea Abstract class for reaction rate per flame area unit C meshReader This class supports creating polyMeshes with baffles C cellFaceIdentifier Identify cell faces in terms of cell Id and face Id C boundaryRegion The boundaryRegion persistent data saved as a Map<dictionary> C cellTable The cellTable persistent data saved as a Map<dictionary> C meshWriter Write OpenFOAM meshes and/or results to another CFD format C polyDualMesh Creates dual of polyMesh C addpointHistoryToDebug C pointHistory C freeSurfacePressureFvPatchScalarField This boundary condition provides static pressure condition for p_rgh, calculated as: C freeSurfaceVelocityFvPatchVectorField This boundary condition provides a velocity outlet boundary condition for free surface patches C interfaceTrackingFvMesh The interfaceTrackingFvMesh C surfactantProperties C dynamicFvMesh Abstract base class for geometry and/or topology changing fvMesh C dynamicInkJetFvMesh Mesh motion specifically for the "pumping" system of an ink-jet injector C dynamicMotionSolverFvMesh The dynamicMotionSolverFvMesh C dynamicMotionSolverFvMeshAMI The dynamicMotionSolverFvMeshAMI C dynamicMotionSolverListFvMesh Dynamic mesh able to handle multiple motion solvers. NOTE: If the word entry "solvers" is not found it falls back to a single motion solver behavior C dynamicMultiMotionSolverFvMesh Mesh motion described per cellZone . Individual motion solvers solve over whole domain but are only applied per cellZone C dynamicRefineFvMesh A fvMesh with built-in refinement C staticFvMesh Foam::staticFvMesh C attachDetach Attach/detach boundary mesh modifier. This modifier takes a set of internal faces and converts them into boundary faces and vice versa based on the given activation switch C boundaryMesh Addressing for all faces on surface of mesh. Can either be read from polyMesh or from triSurface . Used for repatching existing meshes C boundaryPatch Like polyPatch but without reference to mesh. Used in boundaryMesh to hold data on patches. The patchIdentifier::index is set, but not used C minEqOp< labelPair > C createShellMesh Creates mesh by extruding a patch C extrudePatchMesh Mesh at a patch created on the fly. The following entry should be used on the field boundary dictionary: C fvMeshAdder Adds two fvMeshes without using any polyMesh morphing. Uses polyMeshAdder C addfvMeshDistributeToDebug C lessProcPatches Less function class that can be used for sorting processor patches C fvMeshDistribute Sends/receives parts of mesh+fvfields to neighbouring processors. Used in load balancing C fvMeshSubsetter Extends Foam::fvMeshSubset with two-step subsetting (uses polyTopoChange modification) C layerAdditionRemoval Cell layer addition mesh modifier C pTraits< edge > Template specialization for pTraits<edge> so we can use syncTools C cellCuts Description of cuts across cells C cellLooper Abstract base class. Concrete implementations know how to cut a cell (i.e. determine a loop around the circumference) C geomCellLooper Implementation of cellLooper . Does pure geometric cut through cell C hexCellLooper Implementation of cellLooper C topoCellLooper Implementation of cellLooper . This one recognizes splitHexes and tries to make a cut such that if the neighbour was split (in a previous iteration) this one also gets split in the same direction so that the result will be a mesh without splitHexes C directionInfo Holds direction in which to split cell (in fact a local coordinate axes). Information is a label and a direction C is_contiguous< directionInfo > Contiguous data for directionInfo C directions Set of directions for each cell in the mesh. Either uniform and size=1 or one set of directions per cell C edgeVertex Combines edge or vertex in single label. Used to specify cuts across cell circumference C boundaryCutter Does modifications to boundary faces C meshCutAndRemove Like meshCutter but also removes non-anchor side of cell C meshCutter Cuts (splits) cells C multiDirRefinement Does multiple pass refinement to refine cells in multiple directions C refinementIterator Utility class to do iterating meshCutter until all requests satisfied C undoableMeshCutter The main refinement handler. Gets cellCuts which is structure that describes which cells are to be cut and in what way. Maintains an undo list (if told so during construction). Apart from undo list is just wrapper around meshCutter C refineCell Container with cells to refine. Refinement given as single direction C splitCell Description of cell after splitting. Contains cellLabel and pointers to cells it it split in. See directedRefinement C wallLayerCells After construction is a list of <refineCell > of cells within a certain distance to the wall and with the wall normal direction C wallNormalInfo Holds information regarding nearest wall point. Used in wall refinement C is_contiguous< wallNormalInfo > Contiguous data for wallNormalInfo C badQualityToCell Selects bad quality cells (using snappyHexMesh/cvMesh mesh quality selector) C badQualityToFace Selects bad quality faces (using snappyHexMesh/cvMesh mesh quality selector) C motionSmoother Given a displacement moves the mesh by scaling the displacement back until there are no more mesh errors C motionSmootherAlgo Given a displacement moves the mesh by scaling the displacement back until there are no more mesh errors C motionSmootherData C polyMeshGeometry Updateable mesh geometry and checking routines C componentDisplacementMotionSolver Virtual base class for displacement motion solver C componentVelocityMotionSolver Virtual base class for velocity motion solver C codedPoints0MotionSolver Provides a general interface to enable dynamic code compilation of mesh motion solvers C displacementMotionSolver Virtual base class for displacement motion solver C zoneMotion Intermediate class for handling "zonified" motion. Can select motion for the entire mesh, or restrict to a subset of points based on a specified cellSet or cellZone(s) C displacementInterpolationMotionSolver Mesh motion solver for an fvMesh C displacementLayeredMotionMotionSolver Mesh motion solver for an (multi-block) extruded fvMesh . Gets given the structure of the mesh blocks and boundary conditions on these blocks C pointEdgeStructuredWalk Determines length of string of edges walked to point C is_contiguous< pointEdgeStructuredWalk > Contiguous data for pointEdgeStructuredWalk C multiDisplacementMotionSolver Mesh motion solver for a polyMesh . Applies multiple (displacement) motion solvers in order C points0MotionSolver Virtual base class for displacement motion solvers, where the point motion is relative to a set of fixed points (points0) C displacementPointSmoothingMotionSolver Quality-based under-relaxation for run-time selectable point smoothing C displacementSmartPointSmoothingMotionSolver Quality-based under-relaxation for run-time selectable point smoothing. WIP C cellPointConnectivity This class provides ordered connectivity for each point of each cell. Lists are available of the points and faces surrounding each point of a cell. The lists are ordered so that the connected points describe a polygonal cone. For a convex cell, any three sequantial cone edges form a positive basis C pointSmoother Abstract base class for point smoothing methods. Handles parallel communication via reset and average functions C multiSolidBodyMotionSolver Solid-body motion of the mesh specified by a run-time selectable motion function C solidBodyMotionDisplacementPointPatchVectorField Enables the specification of a fixed value boundary condition using the solid body motion functions C solidBodyMotionSolver Solid-body motion of the mesh specified by a run-time selectable motion function C motionSolver Virtual base class for mesh motion solver C iNew Class used for the construction of PtrLists of motionSolvers C velocityDisplacementMotionSolver Mesh motion solver for a polyMesh . Wraps a displacement motion solver in a velocity motion solver C velocityMotionSolver Virtual base class for velocity motion solver C perfectInterface Hack of attachDetach to couple patches when they perfectly align. Does not decouple. Used by stitchMesh app. Does geometric matching C externalPointEdgePoint Holds information regarding nearest wall point. Used in PointEdgeWave . (so not standard FaceCellWave ) To be used in wall distance calculation C trackingData Class used to pass data into container C is_contiguous< externalPointEdgePoint > Contiguous data for externalPointEdgePoint C pointPatchDist Calculation of distance to nearest patch for all points C faceCoupleInfo Container for information needed to couple to meshes. When constructed from two meshes and a geometric tolerance finds the corresponding boundary faces C polyMeshAdder Adds two meshes without using any polyMesh morphing C polyMeshFilter Remove the edges and faces of a polyMesh whilst satisfying the given mesh quality criteria C polyMeshFilterSettings Class to store the settings for the polyMeshFilter class C attachPolyTopoChanger This class is derived from polyMesh and serves as a tool for statically connecting pieces of a mesh by executing the mesh modifiers and cleaning the mesh C polyMeshModifier Virtual base class for mesh modifiers C combineEqOpFace C addPatchCellLayer Adds layers of cells to outside (or inside) of polyMesh . Can optionally create stand-alone extruded mesh (addToMesh=false) C combineFaces Combines boundary faces into single face. The faces get the patch of the first face ('the master') C duplicatePoints Duplicate points C edgeCollapser Does polyTopoChanges to remove edges. Can remove faces due to edge collapse but can not remove cells due to face removal! Also removes unused points C faceCollapser Collapses faces into edges. Used to remove sliver faces (faces with small area but non-zero span) C ifEqEqOp Reduction class. If x and y are not equal assign value C hexRef8 Refinement of (split) hexes using polyTopoChange C hexRef8Data Various for reading/decomposing/reconstructing/distributing refinement data C refinementHistory All refinement history. Used in unrefinement C splitCell8 C pointEdgeCollapse Determines length of string of edges walked to point C is_contiguous< pointEdgeCollapse > Contiguous data for pointEdgeCollapse C refinementData Transfers refinement levels such that slow transition between levels is maintained. Used in FaceCellWave C is_contiguous< refinementData > Contiguous data for refinementData C is_contiguous_label< refinementData > Contiguous label data for refinementData C refinementDistanceData Transfers refinement levels such that slow transition between levels is maintained. Used in FaceCellWave C is_contiguous< refinementDistanceData > Contiguous data for refinementDistanceData C removeCells Given list of cells to remove, insert all the topology changes C removeFaces Given list of faces to remove insert all the topology changes. Contains helper function to get consistent set of faces to remove C faceEqOp C removePoints Removes selected points from mesh and updates faces using these points C tetDecomposer Decomposes polyMesh into tets (or pyramids) C polyTopoChanger List of mesh modifiers defining the mesh dynamics C repatchPolyTopoChanger A mesh which allows changes in the patch distribution of the boundary faces. The change in patching is set using changePatchID. For a boundary face, a new patch ID is given C setUpdater Keeps cell/face/vertex sets uptodate. Both the ones loaded and the ones on disk C enrichedPatch The enriched patch contains a double set of faces from the two sides of the sliding interface before the cutting C slidingInterface Sliding interface mesh modifier. Given two face zones, couple the master and slave side using a cutting procedure C engineMesh Foam::engineMesh C fvMotionSolverEngineMesh Foam::fvMotionSolverEngineMesh C layeredEngineMesh Foam::layeredEngineMesh C staticEngineMesh Foam::staticEngineMesh C enginePiston Foam::enginePiston C crankConRod Manage time in terms of engine RPM and crank-angle C engineTime An abstract class for the time description of the piston motion C freePiston In case of free pistons, the piston position is determined by a user-defined position according to time C engineValve Foam::engineValve C ignition Foam::ignition C ignitionSite Foam::ignitionSite C iNew Read-construction of PtrLists of ignitionSite C colourTable Base class for generating a colour table from node points C manifoldCellsMeshObject Provides cell-to-faces ('cells() ') with duplicate faces removed C ensightCase Supports writing of ensight cases as well as providing common factory methods to open new files C options Configuration options for the ensightCase C ensightFile A variant of OFstream with specialised handling for Ensight writing of strings, integers and floats (ASCII and BINARY) C ensightGeoFile A variant of ensightFile (Ensight writing) that includes the extra geometry file header information C ensightMesh Encapsulation of volume meshes for writing in ensight format. It manages cellZones, facesZone, patches C options Configuration options for the ensightMesh C Hash< ensight::FileName > Hashing for FileName is the same as string C Hash< ensight::VarName > Hashing for VarName is the same as string C InfoProxy A helper class for outputting values to Ostream C ensightCells Sorting/classification of cells (3D) into corresponding ensight element types C ensightFaces Sorting/classification of faces (2D) into corresponding ensight types C ensightPart Base class for ensightCells , ensightFaces , ensightOutputSurfaces C ensightOutputSurface A variant of ensightFaces that holds references to contiguous points/faces with its own encapsulated write methods. The surface is assumed to have been merged prior, thus the output is serial-only C ensightReadFile A variant of IFstream with specialised handling for Ensight reading of strings, integers and floats (ASCII and BINARY) C ensightPTraits Ensight names and component order for base types C JSONformatter An wrapper for Ostream that outputs content in JSON format C OBJstream An OFstream that keeps track of vertices and provides convenience output methods for OBJ files C STLpoint A vertex point or facet normal representation for STL files C STLtriangle A triangle representation for STL files C SymmTensor A templated (3 x 3) symmetric tensor of objects of <T>, effectively containing 6 elements, derived from VectorSpace C vtkPTraits Names for VTK primitive types C foamVtkMeshMaps Bookkeeping for mesh subsetting and/or polyhedral cell decomposition. Although the main use case is for handling vtk meshes, it is not specific to VTK alone C vtkUnstructuredReader Reader for vtk UNSTRUCTURED_GRID legacy files. Supports single CELLS, POINTS etc. entry only C areaMesh Mesh data needed to do the Finite Area discretisation C faMeshDistributor Holds a reference to the original mesh (the baseMesh) and optionally to a subset of that mesh (the subMesh) with mapping lists for points, faces, and cells C edgeMesh Mesh data needed to do the Finite Area discretisation C faMatrix A special matrix type and solver, designed for finite area solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise C faSolver Solver class returned by the solver function used for systems in which it is useful to cache the solver for reuse C UIndirectList A List with indirect addressing. Like IndirectList but does not store addressing C faBoundaryMesh Finite area boundary mesh, which is a faPatch list with registered IO, a reference to the associated faMesh , with additional search methods etc C faBoundaryMeshEntries Read and store dictionary entries for finite-area boundary patches. The object is *never* registered to avoid registry name clashes with faBoundaryMesh , which may either already have been registered, or which should subsequently be registered C faGlobalMeshData Various mesh related information for a parallel run C faMeshRegistry The objectRegistry for faMesh C faMesh Finite area mesh (used for 2-D non-Euclidian finite area method) defined using a patch of faces on a polyMesh (ie, uindirectPrimitivePatch ) C faMeshBoundaryHalo Class for obtaining halo face data for the boundary edges. The ordering follows that natural edge ordering of the underlying primitive patch C faMeshesRegistry A MeshObject registry on top of a polyMesh that provides an objectRegistry for holding multiple faMesh objects C faMeshLduAddressing LduAddressing wrapper for faMesh C faAreaMapper FA area mapper C faBoundaryMeshMapper Foam::faBoundaryMeshMapper C faEdgeMapper FA edge mapper. Currently, edge-based finite area data is not mapped, but only resized, since edge-based mapping data is not available C faMeshMapper Class holds all the necessary information for mapping fields associated with faMesh C faPatchMapper Mapping class for a faPatchField . Edge mapping is calculated based on faceCells comparison of old and new patch C faMeshSubset Holds a reference to the original mesh (the baseMesh) and optionally to a subset of that mesh (the subMesh) with mapping lists for points, faces, and cells C faMeshTools A collection of tools for operating on an faMesh C coupledFaPatch CoupledFaPatch is an abstract base class for patches that couple regions of the computational domain e.g. cyclic, arbitrary interfaces, sliding interfaces and processor-processor links C cyclicFaPatch Cyclic-plane patch C emptyFaPatch A patch which will not exist in the faMesh . Typical example is a front and back plane of a 2-D geometry C processorFaPatch Processor patch C symmetryFaPatch Symmetry-plane patch C wedgeFaPatch Wedge front and back plane patch C faPatch Finite area patch class. Used for 2-D non-Euclidian finite area method C faPatchData Helper class for holding data during faPatch construction. Most data members are exposed at the moment C ignoreFaPatch A patch which will not exist in the faMesh . Typical example is a front and back plane of a 2-D geometry C faFaceZone A subset of finite-area face elements C ZoneMesh A list of mesh zones C faSolution Selector class for finite area solution. faMesh is derived from faSolution so that all fields have access to the faSolution from the mesh reference they hold C faPatchField FaPatchField<Type> abstract base class. This class gives a fat-interface to all derived classes covering all possible ways in which they might be used. The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions. The next level of derivation covers all the specialised typed with specific evaluation procedures, particularly with respect to specific fields C SlicedGeometricField Specialization of GeometricField which holds slices of given complete fields in a form that they act as a GeometricField C slicedFaPatchField Specialization of faPatchField which creates the underlying faPatchField as a slice of the given complete field C faePatchField FaePatchField<Type> abstract base class. This class gives a fat-interface to all derived classes covering all possible ways in which they might be used. The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions. The next level of derivation covers all the specialised typed with specific evaluation procedures, particularly with respect to specific fields C slicedFaePatchField Specialization of faePatchField which creates the underlying faePatchField as a slice of the given complete field C calculatedFaePatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C coupledFaePatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C fixedValueFaePatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C zeroValueFaePatchField Specifies a zero fixed value boundary condition C cyclicFaePatchField Foam::cyclicFaePatchField C emptyFaePatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C processorFaePatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C symmetryFaePatchField Foam::symmetryFaePatchField C wedgeFaePatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C faePatchFieldBase Template invariant parts for faePatchField C basicSymmetryFaPatchField A symmetry patch C calculatedFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C coupledFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C extrapolatedCalculatedFaPatchField This boundary condition applies a zero-gradient condition from the patch internal field onto the patch faces when evaluated but may also be assigned. snGrad returns the patch gradient evaluated from the current internal and patch field values rather than returning zero C fixedGradientFaPatchField This boundary condition supplies a fixed gradient condition, such that the patch values are calculated using: C fixedValueFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C mixedFaPatchField This boundary condition provides a base class for 'mixed' type boundary conditions, i.e. conditions that mix fixed value and patch-normal gradient conditions C transformFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C zeroGradientFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C zeroValueFaPatchField Specifies a zero fixed value boundary condition C cyclicFaPatchField Foam::cyclicFaPatchField C emptyFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C processorFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C symmetryFaPatchField Foam::symmetryFaPatchField C wedgeFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C clampedPlateFaPatchField This BC provides a clamped BC. It sets zero fixed value and zeroGradient C edgeNormalFixedValueFaPatchVectorField Edge normal fixed value vector field finite area boundary condition C fixedValueOutflowFaPatchField Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd C ignoreFaPatchField A boundary condition for invalid edges which should be ignored. Currently functionally identical to a zero-gradient condition C inletOutletFaPatchField This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow C outletInletFaPatchField This boundary condition provides a generic inflow condition, with specified outflow for the case of reverse flow C slipFaPatchField Foam::slipFaPatchField C timeVaryingUniformFixedValueFaPatchField A time-varying form of a uniform fixed value finite area boundary condition C uniformFixedGradientFaPatchField This boundary condition provides a uniform fixed gradient condition C uniformFixedValueFaPatchField This boundary condition provides a uniform fixed value condition C uniformMixedFaPatchField This boundary condition provides 'mixed' type boundary condition that mix a uniform fixed value and a uniform patch-normal gradient condition. The term "uniform" is a legacy name since the prescribed values were previously spatially uniform across that patch C faPatchFieldBase Template invariant parts for faPatchField C faPatchFieldMapper A FieldMapper for finite-area patch fields C faSchemes Selector class for finite area differencing schemes. faMesh is derived from faSchemes so that all fields have access to the faSchemes from the mesh reference they hold C is_globalIOobject< faSchemes > Global file type for faSchemes - same content for all ranks C leastSquaresFaVectors Least-squares gradient scheme vectors for the Finite Area method C edgeInterpolation Face to edge interpolation scheme. Included in faMesh C edgeInterpolationScheme Abstract base class for edge interpolation schemes C blendedEdgeInterpolation Linear/upwind blended differencing scheme C GammaWeight Class with operator() which returns the weighting factors for the Gamma differencing scheme. Used in conjunction with the template class NVDscheme C leastSquaresEdgeInterpolation Least-squares edge interpolation scheme class, from face centers to points then from points to edges C linearEdgeInterpolation Central-differencing interpolation scheme class C linearUpwindWeight Class with operator() which returns the weighting factors for the linear-upwind differencing scheme. Note that the weighting factors are not bounded between upwind and central-differencing, some downwind contribution is possible although the interpolate is limited to be between the upwind and downwind cell values C faNVDscheme Class to create the weighting-factors based on the NVD (Normalised Variable Diagram) C skewCorrectedEdgeInterpolation Linear/upwind blended differencing scheme C upwindEdgeInterpolation Upwind differencing scheme class C MapInternalField< Type, MeshMapper, areaMesh > C MapInternalField< Type, MeshMapper, edgeMesh > C fvPatchField Abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used C fvsPatchField An abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used C volSurfaceMapping Volume to surface and surface to volume mapping C ensightFaMesh Encapsulation of area meshes for writing in ensight format C NullMRF C IOMRFZoneList List of MRF zones with IO functionality. MRF zones are specified by a list of dictionary entries, e.g C MRFZone MRF zone definition based on cell zone and parameters obtained from a control dictionary constructed from the given stream C MRFZoneList List container for MRF zomes C IOporosityModelList List of porosity models with IO functionality C porosityModel Top level model for porosity models C iNew Return pointer to new porosityModel object created on the freestore C is_globalIOobject< porosityModel > Global file type for porosityModel C porosityModelList List container for porosity models C pressureControl Provides controls for the pressure reference is closed-volume simulations and a general method for limiting the pressure during the startup of steady-state simulations C loopControl A class for managing arbitrary loops with the ability to invoke function object execution C pimpleControl PIMPLE control class to supply convergence information/checks for the PIMPLE loop C pisoControl Specialization of the pimpleControl class for PISO control C simpleControl SIMPLE control class to supply convergence information/checks for the SIMPLE loop C solutionControl Base class for solution control classes C fieldData Simple convenient storage of field residuals C SRFFreestreamVelocityFvPatchVectorField Freestream velocity condition to be used in conjunction with the single rotating frame (SRF ) model (see: SRFModel class) C SRFVelocityFvPatchVectorField Velocity condition to be used in conjunction with the single rotating frame (SRF ) model (see: SRFModel class) C SRFWallVelocityFvPatchVectorField Wall-velocity condition to be used in conjunction with the single rotating frame (SRF ) model (see: FOAM::SRFModel) C exprFixedValueFvPatchField A fixed value boundary condition with expressions C exprMixedFvPatchField A mixed boundary condition with expressions C exprValuePointPatchField A fixed value point boundary condition with expressions C lookupBase Base level of Lookup and LookupField classes C basicSymmetryFvPatchField A symmetry patch. The "value" entry is NO_READ, NO_WRITE C calculatedFvPatchField This boundary condition is not designed to be evaluated; it is assumed that the value is assigned via field assignment, and not via a call to e.g. updateCoeffs or evaluate C coupledFvPatchField Abstract base class for coupled patches C directionMixedFvPatchField Base class for direction-mixed boundary conditions C extrapolatedCalculatedFvPatchField This boundary condition applies a zero-gradient condition from the patch internal field onto the patch faces when evaluated but may also be assigned. snGrad returns the patch gradient evaluated from the current internal and patch field values rather than returning zero C fixedGradientFvPatchField This boundary condition supplies a fixed gradient condition, such that the patch values are calculated using: C fixedValueFvPatchField This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions C mixedFvPatchField This boundary condition provides a base class for 'mixed' type boundary conditions, i.e. conditions that mix fixed value and patch-normal gradient conditions C slicedFvPatchField Specialization of fvPatchField which creates the underlying fvPatchField as a slice of the given complete field C transformFvPatchField Intermediate layer (not used directly as a user boundary condition). The "value" entry is NO_READ, NO_WRITE C zeroGradientFvPatchField This boundary condition applies a zero-gradient condition from the patch internal field onto the patch faces C zeroValueFvPatchField Specifies a zero fixed value boundary condition C calculatedProcessorFvPatchField A processorFvPatchField type bypassing fvPatch C cyclicFvPatchField This boundary condition enforces a cyclic condition between a pair of boundaries C cyclicACMIFvPatchField This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrarily coupled mesh interface (ACMI) interpolation C cyclicAMIFvPatchField This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation C cyclicSlipFvPatchField This boundary condition is a light wrapper around the cyclicFvPatchField condition, providing no new functionality C emptyFvPatchField This boundary condition provides an 'empty' condition for reduced dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to patches whose normal is aligned to geometric directions that do not constitute solution directions C jumpCyclicFvPatchField This boundary condition provides a base class for coupled-cyclic conditions with a specified 'jump' (or offset) between the values C jumpCyclicAMIFvPatchField This boundary condition provides a base class that enforces a cyclic condition with a specified 'jump' (or offset) between a pair of boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation C nonuniformTransformCyclicFvPatchField This boundary condition enforces a cyclic condition between a pair of boundaries, incorporating a non-uniform transformation C processorFvPatchField This boundary condition enables processor communication across patches C processorCyclicFvPatchField This boundary condition enables processor communication across cyclic patches C symmetryFvPatchField This boundary condition enforces a symmetry constraint C symmetryPlaneFvPatchField This boundary condition enforces a symmetryPlane constraint C wedgeFvPatchField This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries C acousticWaveTransmissiveFvPatchField This boundary condition provides a wave transmissive outflow condition, based on solving DDt(W, field) = 0 at the boundary W is the wave velocity and field is the field to which this boundary condition is applied. The wave speed is input in the BC C activeBaffleVelocityFvPatchVectorField This velocity boundary condition simulates the opening of a baffle due to local flow conditions, by merging the behaviours of wall and cyclic conditions. The baffle joins two mesh regions, where the open fraction determines the interpolation weights applied to each cyclic- and neighbour-patch contribution C activePressureForceBaffleVelocityFvPatchVectorField This boundary condition is applied to the flow velocity, to simulate the opening or closure of a baffle due to area averaged pressure or force delta, between both sides of the baffle. This is achieved by merging the behaviours of wall and cyclic baffles C advectiveFvPatchField This boundary condition provides an advective outflow condition, based on solving DDt(W, field) = 0 at the boundary where W is the wave velocity and field is the field to which this boundary condition is applied C codedFixedValueFvPatchField Constructs on-the-fly a new boundary condition (derived from fixedValueFvPatchField ) which is then used to evaluate C codedMixedFvPatchField Constructs on-the-fly a new boundary condition (derived from mixedFvPatchField ) which is then used to evaluate C cylindricalInletVelocityFvPatchVectorField This boundary condition describes an inlet vector boundary condition in cylindrical coordinates given a central axis, central point, rpm, axial and radial velocity C electrostaticDepositionFvPatchScalarField The electrostaticDeposition is a boundary condition to calculate electric potential (V) on a given boundary based on film thickness (h) and film resistance (R) fields which are updated based on a given patch-normal current density field (jn), Coulombic efficiency and film resistivity C fanFvPatchField This boundary condition provides a jump condition, using the cyclic condition as a base C fanPressureFvPatchScalarField This boundary condition can be applied to assign either a pressure inlet or outlet total pressure condition for a fan C fixedFluxExtrapolatedPressureFvPatchScalarField This boundary condition sets the pressure gradient to the provided value such that the flux on the boundary is that specified by the velocity boundary condition C fixedFluxPressureFvPatchScalarField This boundary condition sets the pressure gradient to the provided value such that the flux on the boundary is that specified by the velocity boundary condition C fixedInternalValueFvPatchField This boundary condition provides a mechanism to set boundary (cell) values directly into a matrix, i.e. to set a constraint condition. Default behaviour is to act as a zero gradient condition C fixedJumpFvPatchField This boundary condition provides a jump condition, using the cyclic condition as a base C fixedJumpAMIFvPatchField This boundary condition provides a jump condition, across non-conformal cyclic path-pairs, employing an arbitraryMeshInterface (AMI) C fixedMeanFvPatchField This boundary condition extrapolates field to the patch using the near-cell values and adjusts the distribution to match the specified, optionally time-varying, mean value C fixedMeanOutletInletFvPatchField This boundary condition extrapolates field to the patch using the near-cell values and adjusts the distribution to match the specified, optionally time-varying, mean value. This extrapolated field is applied as a fixedValue for outflow faces but zeroGradient is applied to inflow faces C fixedNormalInletOutletVelocityFvPatchVectorField This velocity inlet/outlet boundary condition combines a fixed normal component obtained from the "normalVelocity" patchField supplied with a fixed or zero-gradiented tangential component C fixedNormalSlipFvPatchField This boundary condition sets the patch-normal component to the field (vector or tensor) to the patch-normal component of a user specified field. The tangential component is treated as slip, i.e. copied from the internal field C fixedPressureCompressibleDensityFvPatchScalarField This boundary condition calculates a (liquid) compressible density as a function of pressure and fluid properties: C fixedProfileFvPatchField This boundary condition provides a fixed value profile condition C flowRateInletVelocityFvPatchVectorField Velocity inlet boundary condition either correcting the extrapolated velocity or creating a uniform velocity field normal to the patch adjusted to match the specified flow rate C flowRateOutletVelocityFvPatchVectorField Velocity outlet boundary condition which corrects the extrapolated velocity to match the specified flow rate C fluxCorrectedVelocityFvPatchVectorField This boundary condition provides a velocity outlet boundary condition for patches where the pressure is specified. The outflow velocity is obtained by "zeroGradient" and then corrected from the flux: C freestreamFvPatchField This boundary condition provides a free-stream condition. It is a 'mixed' condition derived from the inletOutlet condition, whereby the mode of operation switches between fixed (free stream) value and zero gradient based on the sign of the flux C freestreamPressureFvPatchScalarField This boundary condition provides a free-stream condition for pressure C freestreamVelocityFvPatchVectorField This boundary condition provides a free-stream condition for velocity C inletOutletFvPatchField This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow C inletOutletTotalTemperatureFvPatchScalarField This boundary condition provides an outflow condition for total temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow C interfaceCompressionFvPatchScalarField Applies interface-compression to the phase-fraction distribution at the patch by setting the phase-fraction to 0 if it is below 0.5, otherwise to 1 C interstitialInletVelocityFvPatchVectorField Inlet velocity in which the actual interstitial velocity is calculated by dividing the specified inletVelocity field with the local phase-fraction C mappedFieldFvPatchField This boundary condition provides a self-contained version of the mapped condition. It does not use information on the patch; instead it holds the data locally C mappedMixedFieldFvPatchField This boundary condition provides a self-contained version of e.g. mapped boundary conditions C interpolation Abstract base class for volume field interpolation C mappedPatchFieldBase Functionality for sampling fields using mappedPatchBase . Every call to mappedField() returns a sampled field, optionally scaled to maintain an area-weighted average C mappedFixedInternalValueFvPatchField This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this C mappedFixedPushedInternalValueFvPatchField This boundary condition maps the boundary values of a neighbour patch field to the boundary and internal cell values of *this C mappedFixedValueFvPatchField This boundary condition maps the value at a set of cells or patch faces back to *this C mappedFlowRateFvPatchVectorField Describes a volumetric/mass flow normal vector boundary condition by its magnitude as an integral over its area C mappedMixedFvPatchField This boundary condition maps the value at a set of cells or patch faces back to *this C mappedVelocityFluxFixedValueFvPatchField This boundary condition maps the velocity and flux from a neighbour patch to this patch C matchedFlowRateOutletVelocityFvPatchVectorField Velocity outlet boundary condition which corrects the extrapolated velocity to match the flow rate of the specified corresponding inlet patch C movingWallVelocityFvPatchVectorField This boundary condition provides a velocity condition for cases with moving walls C noSlipFvPatchVectorField This boundary condition fixes the velocity to zero (eg, at walls) C outletInletFvPatchField This boundary condition provides a generic inflow condition, with specified outflow for the case of reverse flow C outletMappedUniformInletFvPatchField The outletMappedUniformInlet is an inlet boundary condition that C outletPhaseMeanVelocityFvPatchVectorField This boundary condition adjusts the velocity for the given phase to achieve the specified mean thus causing the phase-fraction to adjust according to the mass flow rate C partialSlipFvPatchField This boundary condition provides a partial slip condition. The amount of slip is controlled by a user-supplied field C phaseHydrostaticPressureFvPatchScalarField This boundary condition provides a phase-based hydrostatic pressure condition, calculated as: C plenumPressureFvPatchScalarField This boundary condition provides a plenum pressure inlet condition. This condition creates a zero-dimensional model of an enclosed volume of gas upstream of the inlet. The pressure that the boundary condition exerts on the inlet boundary is dependent on the thermodynamic state of the upstream volume. The upstream plenum density and temperature are time-stepped along with the rest of the simulation, and momentum is neglected. The plenum is supplied with a user specified mass flow and temperature C pressureDirectedInletOutletVelocityFvPatchVectorField This velocity inlet/outlet boundary condition is applied to velocity boundaries where the pressure is specified. A zero-gradient condition is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with the specified inlet direction C pressureDirectedInletVelocityFvPatchVectorField This velocity inlet boundary condition is applied to patches where the pressure is specified. The inflow velocity is obtained from the flux with the specified inlet direction" direction C pressureInletOutletParSlipVelocityFvPatchVectorField This velocity inlet/outlet boundary condition for pressure boundary where the pressure is specified. A zero-gradient is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with the specified inlet direction C pressureInletOutletVelocityFvPatchVectorField This velocity inlet/outlet boundary condition is applied to velocity boundaries where the pressure is specified. A zero-gradient condition is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the patch-face normal component of the internal-cell value C pressureInletUniformVelocityFvPatchVectorField This velocity inlet boundary condition is applied to patches where the pressure is specified. The uniform inflow velocity is obtained by averaging the flux over the patch, and then applying it in the direction normal to the patch faces C pressureInletVelocityFvPatchVectorField This velocity inlet boundary condition is applied to patches where the pressure is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces C pressureNormalInletOutletVelocityFvPatchVectorField This velocity inlet/outlet boundary condition is applied to patches where the pressure is specified. A zero-gradient condition is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces C pressurePermeableAlphaInletOutletVelocityFvPatchVectorField The pressurePermeableAlphaInletOutletVelocity is a velocity inlet-outlet boundary condition which can be applied to velocity boundaries for multiphase flows when the pressure boundary condition is specified C pressurePIDControlInletVelocityFvPatchVectorField This boundary condition tries to generate an inlet velocity that maintains a specified pressure drop between two face zones downstream. The zones should fully span a duct through which all the inlet flow passes C prghPermeableAlphaTotalPressureFvPatchScalarField The prghPermeableAlphaTotalPressure is a mixed boundary condition for the p_rgh variable in multiphase flows C prghPressureFvPatchScalarField This boundary condition provides static pressure condition for p_rgh, calculated as: C prghTotalHydrostaticPressureFvPatchScalarField This boundary condition provides static pressure condition for p_rgh, calculated as: C prghTotalPressureFvPatchScalarField This boundary condition provides static pressure condition for p_rgh, calculated as: C rotatingPressureInletOutletVelocityFvPatchVectorField This velocity inlet/outlet boundary condition is applied to patches in a rotating frame where the pressure is specified. A zero-gradient is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces C rotatingTotalPressureFvPatchScalarField This boundary condition provides a total pressure condition for patches in a rotating frame C rotatingWallVelocityFvPatchVectorField This boundary condition provides a rotational velocity condition C scaledFixedValueFvPatchField This condition applies a scalar multiplier to the value of another boundary condition C slipFvPatchField This boundary condition provides a slip constraint C supersonicFreestreamFvPatchVectorField This boundary condition provides a supersonic free-stream condition C surfaceNormalFixedValueFvPatchVectorField This boundary condition provides a surface-normal vector boundary condition by its magnitude C swirlFanVelocityFvPatchField This boundary condition provides a jump condition for U across a cyclic pressure jump condition and applies a transformation to U C swirlFlowRateInletVelocityFvPatchVectorField This boundary condition provides a volumetric- OR mass-flow normal vector boundary condition by its magnitude as an integral over its area with a swirl component determined by the angular speed, given in revolutions per minute (RPM) C swirlInletVelocityFvPatchVectorField This boundary condition describes an inlet vector boundary condition in swirl coordinates given a central axis, central point, axial, radial and tangential velocity profiles C syringePressureFvPatchScalarField This boundary condition provides a pressure condition, obtained from a zero-D model of the cylinder of a syringe C timeVaryingMappedFixedValueFvPatchField This boundary conditions interpolates the values from a set of supplied points in space and time C totalPressureFvPatchScalarField This boundary condition provides a total pressure condition. Four variants are possible: C totalTemperatureFvPatchScalarField This boundary condition provides a total temperature condition C translatingWallVelocityFvPatchVectorField This boundary condition provides a velocity condition for translational motion on walls C eddy Class to describe eddies for the turbulentDFSEMInletFvPatchVectorField boundary condition C turbulentDFSEMInletFvPatchVectorField The turbulentDFSEMInlet is a synthesised-eddy based velocity inlet boundary condition to generate synthetic turbulence-alike time-series from a given set of turbulence statistics for LES and hybrid RANS-LES computations C turbulentDigitalFilterInletFvPatchField Digital-filter based boundary condition for vector- and scalar-based quantities (e.g. U or T) to generate synthetic turbulence-alike time-series from input turbulence statistics for LES and DES turbulent flow computations C turbulentInletFvPatchField This boundary condition produces spatiotemporal-variant field by summing a set of pseudo-random numbers and a given spatiotemporal-invariant mean field. The field can be any type, e.g. scalarField . At a single point and time, all components are summed by the same random number, e.g. velocity components (u, v, w) are summed by the same random number, p; thus, output is (u+p, v+p, w+p) C turbulentIntensityKineticEnergyInletFvPatchScalarField This boundary condition provides a turbulent kinetic energy condition, based on user-supplied turbulence intensity, defined as a fraction of the mean velocity: C uniformDensityHydrostaticPressureFvPatchScalarField This boundary condition provides a hydrostatic pressure condition, calculated as: C uniformFixedGradientFvPatchField This boundary condition provides a uniform fixed gradient condition C uniformFixedValueFvPatchField This boundary condition provides a uniform fixed value condition C uniformInletOutletFvPatchField Variant of inletOutlet boundary condition with uniform inletValue C uniformJumpFvPatchField This boundary condition provides a jump condition, using the cyclic condition as a base. The jump is specified as a time-varying uniform value across the patch C uniformJumpAMIFvPatchField This boundary condition provides a jump condition, using the cyclicAMI condition as a base. The jump is specified as a time-varying uniform value across the patch C uniformMixedFvPatchField This boundary condition provides 'mixed' type boundary condition that mix a uniform fixed value and a uniform patch-normal gradient condition. The term "uniform" is a legacy name since the prescribed values were previously spatially uniform across that patch C uniformNormalFixedValueFvPatchVectorField This boundary condition provides a uniform surface-normal vector boundary condition by its magnitude C uniformTotalPressureFvPatchScalarField This boundary condition provides a time-varying form of the uniform total pressure boundary condition Foam::totalPressureFvPatchField C variableHeightFlowRateFvPatchScalarField This boundary condition provides a phase fraction condition based on the local flow conditions, whereby the values are constrained to lay between user-specified upper and lower bounds. The behaviour is described by: C variableHeightFlowRateInletVelocityFvPatchVectorField This boundary condition provides a velocity boundary condition for multphase flow based on a user-specified volumetric flow rate C waveSurfacePressureFvPatchScalarField This is a pressure boundary condition, whose value is calculated as the hydrostatic pressure based on a given displacement: C waveTransmissiveFvPatchField This boundary condition provides a wave transmissive outflow condition, based on solving DDt(W, field) = 0 at the boundary W is the wave velocity and field is the field to which this boundary condition is applied C fvMatrix A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise C fvSolver Solver class returned by the solver function used for systems in which it is useful to cache the solver for reuse C fvPatchFieldBase Template invariant parts for fvPatchField C addfvPatchFieldBaseToDebug C fvPatchFieldMapper A FieldMapper for finite-volume patch fields C calculatedFvsPatchField This boundary condition is not designed to be evaluated; it is assumed that the value is assigned via field assignment C coupledFvsPatchField Abstract base class for coupled patches C fixedValueFvsPatchField This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions C slicedFvsPatchField Specialization of fvsPatchField which creates the underlying fvsPatchField as a slice of the given complete field C zeroValueFvsPatchField Specifies a zero fixed value boundary condition C cyclicFvsPatchField This boundary condition enforces a cyclic condition between a pair of boundaries C cyclicACMIFvsPatchField This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrarily coupled mesh interface (ACMI) interpolation C cyclicAMIFvsPatchField This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation C cyclicSlipFvsPatchField Foam::cyclicSlipFvsPatchField C emptyFvsPatchField This boundary condition provides an 'empty' condition for reduced dimensions cases C nonuniformTransformCyclicFvsPatchField Foam::nonuniformTransformCyclicFvsPatchField C processorFvsPatchField This boundary condition enables processor communication across patches C processorCyclicFvsPatchField This boundary condition enables processor communication across cyclic patches C symmetryFvsPatchField This boundary condition enforces a symmetry constraint C symmetryPlaneFvsPatchField This boundary condition enforces a symmetryPlane constraint C wedgeFvsPatchField This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries C fvsPatchFieldBase Template invariant parts for fvsPatchField C smoothData Helper class used by the fvc::smooth and fvc::spread functions C trackData Class used to pass additional data in C is_contiguous< smoothData > Contiguous data for smoothData C sweepData Helper class used by fvc::sweep function C is_contiguous< sweepData > Contiguous data for sweepData C fvSchemes Selector class for finite volume differencing schemes. fvMesh is derived from fvSchemes so that all fields have access to the fvSchemes from the mesh reference they hold C is_globalIOobject< fvSchemes > Global file type for fvSchemes - same content for all ranks C fvSolution Selector class for finite volume solution solution. fvMesh is derived from fvSolution so that all fields have access to the fvSolution from the mesh reference they hold C leastSquaresVectors Least-squares gradient scheme vectors C CentredFitSnGradData Data for centred fit snGrad schemes C faceAreaPairGAMGAgglomeration Agglomerate using the pair algorithm C leastSquareGrad Estimates the gradient with a least square scheme in a cell C multiDimPolyFitter Fit a polynominal function with the help of multiDimPolyFunction C multiDimPolyFunctions Base class for polynomial functions C polyDegree1 First degree polynominal function C extendedCellToCellStencil Baseclass for cell-to-cell stencils C extendedCentredCellToCellStencil C CECCellToCellStencil C cellToCellStencil Baseclass for extended cell centred addressing. Contains per cell a list of neighbouring cells and/or boundaryfaces in global addressing C CFCCellToCellStencil C CPCCellToCellStencil C centredCECCellToCellStencilObject C centredCFCCellToCellStencilObject C centredCPCCellToCellStencilObject C extendedCellToFaceStencil Calculates/constains the extended cell-to-face stencil C extendedCentredCellToFaceStencil C extendedUpwindCellToFaceStencil Creates upwind stencil by shifting a centred stencil to upwind and downwind faces and optionally removing all non-(up/down)wind faces ('pureUpwind') C CECCellToFaceStencil Combined corresponding cellToCellStencil of owner and neighbour C cellToFaceStencil Base class for extended cell-to-face stencils (face values from neighbouring cells) C CFCCellToFaceStencil Combined corresponding cellToCellStencil of owner and neighbour C CPCCellToFaceStencil Combined corresponding cellToCellStencil of owner and neighbour C FECCellToFaceStencil All cells connected via edge to face C centredCECCellToFaceStencilObject C centredCFCCellToFaceStencilObject C centredCPCCellToFaceStencilObject C centredFECCellToFaceStencilObject C pureUpwindCFCCellToFaceStencilObject C upwindCECCellToFaceStencilObject C upwindCFCCellToFaceStencilObject C upwindCPCCellToFaceStencilObject C upwindFECCellToFaceStencilObject C extendedCentredFaceToCellStencil C extendedFaceToCellStencil Note: transformations on coupled patches not supported. Problem is the positions of cells reachable through these patches C CFCFaceToCellStencil C faceToCellStencil Baseclass for extended cell centred addressing. Contains per cell a list of neighbouring faces in global addressing C centredCFCFaceToCellStencilObject C fvBoundaryMesh A fvBoundaryMesh is a fvPatch list with a reference to the associated fvMesh , with additional search methods etc C averageNeighbourFvGeometryScheme Geometry calculation scheme to minimise non-orthogonality/ C basicFvGeometryScheme Default geometry calculation scheme. Slight stabilisation for bad meshes C fvGeometryScheme Abstract base class for geometry calculation schemes C cellAspectRatio (Rough approximation of) cell aspect ratio C highAspectRatioFvGeometryScheme Geometry calculation scheme with automatic stabilisation for high-aspect ratio cells C parallelFvGeometryScheme Geometry calculation scheme with explicit sync of face-geometry across processor patches C transformOriented Transformation for oriented fields C solidBodyFvGeometryScheme Geometry calculation scheme that performs geometry updates only in regions where the mesh has changed C stabilisedFvGeometryScheme Geometry calculation scheme that implements face geometry calculation using normal-component-of-area weighted triangle contributions C fvMesh Mesh data needed to do the Finite Volume discretisation C fvMeshLduAddressing Foam::fvMeshLduAddressing C fvBoundaryMeshMapper Foam::fvBoundaryMeshMapper C fvMeshMapper Class holds all the necessary information for mapping fields associated with fvMesh C fvPatchMapper Mapping class for a fvPatchField C fvSurfaceMapper A finiteVolume surface mapper C fvMeshSubset Holds a reference to the original mesh (the baseMesh) and optionally to a subset of that mesh (the subMesh) with mapping lists for points, faces, and cells C fvMeshSubsetProxy Simple proxy for holding a mesh, or mesh-subset. The subMeshes are currently limited to cellSet or cellZone definitions C fvMeshTools A collection of tools for operating on an fvMesh C coupledFvPatch An abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links C genericFvPatch FV variant of the genericPolyPatch C cyclicFvPatch Cyclic-plane patch C cyclicACMIFvPatch Cyclic patch for Arbitrarily Coupled Mesh Interface (ACMI) C cyclicAMIFvPatch Cyclic patch for Arbitrary Mesh Interface (AMI) C cyclicSlipFvPatch Cyclic-plane patch C emptyFvPatch A patch which will not exist in the fvMesh . Typical example is a front and back plane of a 2-D geometry C nonuniformTransformCyclicFvPatch Cyclic-plane patch C processorFvPatch Processor patch C processorCyclicFvPatch Processor patch C symmetryFvPatch Symmetry patch for non-planar or multi-plane patches C symmetryPlaneFvPatch Symmetry-plane patch C wedgeFvPatch Wedge front and back plane patch C mappedFvPatch Foam::mappedFvPatch C mappedWallFvPatch Foam::mappedWallFvPatch C wallFvPatch Foam::wallFvPatch C addfvPatchToDebug C fvPatch A finiteVolume patch using a polyPatch and a fvBoundaryMesh C simplifiedFvMesh Functions to generate simplified finite volume meshes C singleCellFvMesh FvMesh as subset of other mesh. Consists of one cell and all original boundary faces. Useful when manipulating boundary data. Single internal cell only needed to be able to manipulate in a standard way C agglomPatchFieldMapper Patch field mapper class for agglomerated meshes C nearWallDist Distance calculation for cells with face on a wall. Searches pointNeighbours to find closest C nearWallDistNoSearch Distance calculation for cells with face on a wall. Does not search anything, just takes normal component of distance C wallDistData Wall distance calculation. Like wallDist but also transports extra data (template argument) C patchDistMethod Specialisation of patchDist for wall distance calculation C wallDist Interface to run-time selectable methods to calculate the distance-to-wall and normal-to-wall fields C wallDistAddressing Variant of wallDist that uses meshWave and stores the addressing C wallPointAddressing Holds information (coordinate and origin) regarding nearest wall point C is_contiguous< wallPointAddressing > Data are contiguous if data type is contiguous C is_contiguous_scalar< wallPointAddressing > C zoneDistribute Class for parallel communication in a narrow band. It either provides a Map with the neighbouring values of the selected region or returns a Map of the required values in global addressing. Also holds a reference to the stencil Before the data transfer the communication has to be set up: exchangeFields_.setUpCommforZone(interfaceCell_); Is used in the plicRDF C zoneCellStencils Base class for cell stencil in a narrow band C zoneCPCStencil Computes a cell point cell stencil in a narrow band. resizes in case of topological change C interpolationCell Uses the cell value for any location within the cell C interpolationCellPatchConstrained Uses the cell value for any point in the cell apart from a boundary face where it uses the boundary value directly. Note: will not work on an empty patch C cellPointWeight Foam::cellPointWeight C interpolationCellPoint Given cell centre values and point (vertex) values decompose into tetrahedra and linear interpolate within them C interpolationCellPointFace Foam::interpolationCellPointFace C cellPointWeightWallModified Foam::cellPointWeightWallModified C interpolationCellPointWallModified Same as interpolationCellPoint , but if interpolating a wall face, uses cell centre value instead C interpolationPointMVC Given cell centre values interpolates to vertices and uses these to do a Mean Value Coordinates interpolation C pointPatchField Abstract base class for point-mesh patch fields C GeometricField Generic GeometricField class C pointMVCWeight Container to calculate weights for interpolating directly from vertices of cell using Mean Value Coordinates C MapInternalField< Type, MeshMapper, surfaceMesh > C MapInternalField< Type, MeshMapper, volMesh > C blendedSchemeBase Base class for blended schemes to provide access to the blending factor surface field C blended Linear/upwind blended differencing scheme C filteredLinearLimiter Class to generate weighting factors for the filteredLinear differencing scheme C filteredLinear2Limiter Class to generate weighting factors for the filteredLinear2 differencing scheme C filteredLinear2VLimiter Class to generate weighting factors for the filteredLinear2V differencing scheme C filteredLinear3Limiter Class to generate weighting factors for the filteredLinear differencing scheme C filteredLinear3VLimiter Class to generate weighting factors for the filteredLinear3V differencing scheme C GammaLimiter Class with limiter function which returns the limiter for the Gamma differencing scheme based on phict obtained from the LimiterFunc class C LimitedLimiter Foam::LimitedLimiter C Limited01Limiter A LimitedLimiter with the range 0-1 C limitedCubicLimiter Class with limiter function which returns the limiter for the TVD limited centred-cubic differencing scheme based on r obtained from the LimiterFunc class C limitedCubicVLimiter Class with limiter function which returns the limiter for the limitedCubicV differencing scheme based on r obtained from the LimiterFunc class C limitedLinearLimiter Class with limiter function which returns the limiter for the TVD limited linear differencing scheme based on r obtained from the LimiterFunc class C LimitedScheme Class to create NVD/TVD limited weighting-factors C NVDTVD Foam::NVDTVD C NVDVTVDV Foam::NVDVTVDV C limitedSurfaceInterpolationScheme Abstract base class for limited surface interpolation schemes C limitWith LimitWith differencing scheme limits the specified scheme with the specified limiter C MinmodLimiter Class with limiter function which returns the limiter for the Minmod differencing scheme C MUSCLLimiter Class with limiter function which returns the limiter for the van Leer's MUSCL differencing scheme C OSPRELimiter Class with limiter function which returns the limiter for the OSPRE differencing scheme based on r obtained from the LimiterFunc class C PhiLimiter Class with limiter function which returns the limiter for the Phi differencing scheme C PhiScheme Class to create the weighting-factors based on the face-flux C QUICKLimiter Class with limiter function which returns the limiter for the quadratic-upwind differencing scheme C QUICKVLimiter Class with limiter function which returns the limiter for the quadratic-upwind differencing scheme C SFCDLimiter Class with limiter function which returns the limiter for the SFCD differencing scheme based on phict obtained from the LimiterFunc class C SuperBeeLimiter Class with limiter function which returns the limiter for the SuperBee differencing scheme based on r obtained from the LimiterFunc class C UMISTLimiter Class with limiter function which returns the limiter for the UMIST differencing scheme C upwind Upwind differencing scheme class C vanAlbadaLimiter Class with limiter function which returns the limiter for the vanAlbada differencing scheme based on r obtained from the LimiterFunc class C vanLeerLimiter Class with limiter function which returns the limiter for the vanLeer differencing scheme based on r obtained from the LimiterFunc class C multivariateIndependentScheme Generic multi-variate discretisation scheme class for which any of the NVD, CNVD or NVDV schemes may be selected for each variable and applied independently C multivariateScheme Generic multi-variate discretisation scheme class which may be instantiated for any of the NVD, CNVD or NVDV schemes C fieldScheme SurfaceInterpolationScheme sub-class returned by operator(field) C multivariateSelectionScheme Generic multi-variate discretisation scheme class for which any of the NVD, CNVD or NVDV schemes may be selected for each variable C fieldScheme SurfaceInterpolationScheme sub-class returned by operator(field) C multivariateSurfaceInterpolationScheme Abstract base class for multi-variate surface interpolation schemes C fieldTable FieldTable C fieldScheme SurfaceInterpolationScheme sub-class returned by operator(field) C multivariateUpwind Upwind-difference form of the multivariate surfaceInterpolationScheme C fieldScheme SurfaceInterpolationScheme sub-class returned by operator(field) C biLinearFitPolynomial BiLinear polynomial for interpolation fitting C cellCoBlended Two-scheme cell-based Courant number based blending differencing scheme C CentredFitData Data for the quadratic fit correction interpolation scheme C CentredFitScheme Centred fit surface interpolation scheme which applies an explicit correction to linear C clippedLinear Central-differencing interpolation scheme using clipped-weights to improve stability on meshes with very rapid variations in cell size C CoBlended Two-scheme Courant number based blending differencing scheme C cubic Cubic interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction C cubicUpwindFitPolynomial Cubic polynomial for upwind biased interpolation fitting C deferredCorrection Deferred correction interpolation scheme wrapper around a run-time selectable base scheme C downwind Downwind differencing scheme class C FitData Data for the upwinded and centred polynomial fit interpolation schemes. The linearCorrection_ determines whether the fit is for a corrected linear scheme (first two coefficients are corrections for owner and neighbour) or a pure upwind scheme (first coefficient is correction for owner; weight on face taken as 1) C fixedBlended Two-scheme fixed-blending differencing scheme C harmonic Harmonic-mean differencing scheme class C limiterBlended Blends two specified schemes using the limiter function provided by a limitedSurfaceInterpolationScheme C linear Central-differencing interpolation scheme class C linearFitPolynomial Linear polynomial for interpolation fitting C linearUpwind LinearUpwind interpolation scheme class derived from upwind and returns upwind weighting factors and also applies a gradient-based explicit correction C linearUpwindV LinearUpwindV interpolation scheme class derived from upwind and returns upwind weighting factors but also applies an explicit correction C localBlended Two-scheme localBlended differencing scheme C localMax LocalMax-mean differencing scheme class C localMin LocalMin-mean differencing scheme class C LUST LUST : Linear-upwind stabilised transport C midPoint Mid-point interpolation (weighting factors = 0.5) scheme class C outletStabilised Outlet-stabilised interpolation scheme which applies upwind differencing to the faces of the cells adjacent to outlets C pointLinear Face-point interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction C PureUpwindFitScheme Upwind biased fit surface interpolation scheme that applies an explicit correction to upwind C quadraticFitPolynomial Quadratic polynomial for centred interpolation fitting C quadraticLinearFitPolynomial Quadratic/linear polynomial for interpolation fitting: quadratic normal to the face, linear in the plane of the face for consistency with 2nd-order Gauss C quadraticLinearUpwindFitPolynomial Quadratic polynomial for upwind biased interpolation fitting C quadraticUpwindFitPolynomial Quadratic polynomial for upwind biased interpolation fitting C reverseLinear Inversed weight central-differencing interpolation scheme class C skewCorrected Skewness-corrected interpolation scheme that applies an explicit correction to given scheme C skewCorrectionVectors Skew-correction vectors for the skewness-corrected interpolation scheme C UpwindFitData Data for the quadratic fit correction interpolation scheme to be used with upwind biased stencil C UpwindFitScheme Upwind biased fit surface interpolation scheme that applies an explicit correction to linear C weighted Interpolation scheme class using weights looked-up from the objectRegistry C weightedFlux Weighted flux interpolation scheme class C zoneBlended Multi-faceZone based blending differencing scheme C surfaceInterpolation Cell to surface interpolation scheme. Included in fvMesh C surfaceInterpolationScheme Abstract base class for surface interpolation schemes C pointConstraints Application of (multi-)patch point constraints C volPointInterpolation Interpolate from cell centres to points (vertices) using inverse distance weighting C assemblyFaceAreaPairGAMGAgglomeration Agglomerate using the pair algorithm C AssemblyFvPatch An assembly of lduMatrix that is specific inter-region coupling through mapped patches C lduPrimitiveMeshAssembly An assembly of lduMatrix that is specific inter-region coupling through mapped patches C surfaceMesh Mesh data needed to do the Finite Volume discretisation C volMesh Mesh data needed to do the Finite Volume discretisation C isVolMesh Template argument for type volMesh C isVolMesh< volMesh > C binModel Base class for bin models to handle general bin characteristics C DMDModel Abstract base class for DMD models to handle DMD characteristics for the DMD function object C externalCoupledMixedFvPatchField Extends the mixed boundary condition with serialisation functions C heatTransferCoeffModel A base class for heat transfer coefficient models C histogramModel A base class for histogram models C findCellParticle Particle class that finds cells by tracking C trackingData Class used to pass tracking data to the trackToFace function C iNew Factory class to read-construct particles (for parallel transfer) C is_contiguous< findCellParticle > Contiguous data for findCellParticle C resolutionIndexModel A base class for resolutionIndex models C streamLineParticle Particle class that samples fields as it passes through. Used in streamline calculation C trackingData C iNew Factory class to read-construct particles used for parallel transfer C streamLineParticleCloud A Cloud of streamLine particles C wallBoundedParticle Particle class that tracks on triangles of boundary faces. Use trackToEdge similar to trackToFace on particle C trackingData Class used to pass tracking data to the trackToFace function C iNew Factory class to read-construct particles (for parallel transfer) C wallBoundedStreamLineParticle Particle class that samples fields as it passes through. Used in streamline calculation C trackingData Class used to pass tracking data to the trackToEdge function C iNew Factory class to read-construct particles (for parallel transfer) C wallBoundedStreamLineParticleCloud A Cloud of wall-bounded streamLine particles C wallHeatFluxModel A base class for heat-flux models C Function1 Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or table, and provide functions to return the (interpolated) value, and integral between limits C addAliasdictionaryConstructorToTable C adddictionaryConstructorToTable C addRemovabledictionaryConstructorToTable C areaWrite Write finite area mesh/fields to standard output formats C substitutionModel Base class for substitution models C parProfilingSolver Wrapper to switch on parProfiling around a linear solver C MGridGenGAMGAgglomeration Agglomerate using the MGridGen algorithm C pairPatchAgglomeration Primitive patch pair agglomerate method C displacementComponentLaplacianFvMotionSolver Mesh motion solver for an fvMesh . Based on solving the cell-centre Laplacian for the given component of the motion displacement C velocityComponentLaplacianFvMotionSolver Mesh motion solver for an fvMesh . Based on solving the cell-centre Laplacian for the given component of the motion velocity C displacementLaplacianFvMotionSolver Mesh motion solver for an fvMesh . Based on solving the cell-centre Laplacian for the motion displacement C displacementSBRStressFvMotionSolver Mesh motion solver for an fvMesh . Based on solving the cell-centre solid-body rotation stress equations for the motion displacement C solidBodyDisplacementLaplacianFvMotionSolver Applies Laplacian displacement solving on top of a transformation of the initial points using a solid-body motion C surfaceAlignedSBRStressFvMotionSolver Mesh motion solver for an fvMesh . Based on solving the cell-centre solid-body rotation stress equations for the motion displacement. The model calculates the necessary rotation to align the stl surface with the closest mesh face normals and it calculates the respective source term for the SBRStress equation C fvMotionSolver Base class for fvMesh based motionSolvers C velocityLaplacianFvMotionSolver Mesh motion solver for an fvMesh . Based on solving the cell-centre Laplacian for the motion velocity C cellMotionFvPatchField Foam::cellMotionFvPatchField C surfaceSlipDisplacementFvPatchField FvPatchField corresponding to surfaceSlipDisplacementPointPatchField. Is just a slip type since all hard work (projection) is done in the pointPatch field C directionalDiffusivity Directional finite volume mesh motion diffusivity C fileDiffusivity Motion diffusivity read from given file name C inverseDistanceDiffusivity Inverse distance to the given patches motion diffusivity C inverseFaceDistanceDiffusivity Inverse distance to the given patches motion diffusivity C inversePointDistanceDiffusivity Inverse distance to the given patches motion diffusivity C inverseVolumeDiffusivity Inverse cell-volume motion diffusivity C exponentialDiffusivity Mesh motion diffusivity maipulator which returns the exp(-alpha/D) of the given diffusivity D C quadraticDiffusivity Mesh motion diffusivity maipulator which returns the sqr of the given diffusivity C motionDiffusivity Abstract base class for cell-centre mesh motion diffusivity C motionDirectionalDiffusivity MotionDirectional finite volume mesh motion diffusivity C uniformDiffusivity Uniform uniform finite volume mesh motion diffusivity C motionInterpolation Base class for interpolation of cell displacement fields, generated by fvMotionSolvers, to the points. This base class implements the default method which applies volPointInterpolation only C patchCorrectedInterpolation Interpolation of cell-based displacements to the points with additional correction for interpolation inconsistency on patches C patchTransformedInterpolation Interpolation of cell-based displacements to the points with additional correction of patch-adjacent cells C angularOscillatingDisplacementPointPatchVectorField Foam::angularOscillatingDisplacementPointPatchVectorField C angularOscillatingVelocityPointPatchVectorField Foam::angularOscillatingVelocityPointPatchVectorField C edgeSlipDisplacementPointPatchVectorField Displacement follows an edgeMesh . Use in a displacementMotionSolver as a bc on the pointDisplacement field C oscillatingDisplacementPointPatchVectorField Foam::oscillatingDisplacementPointPatchVectorField C oscillatingVelocityPointPatchVectorField Foam::oscillatingVelocityPointPatchVectorField C pointAttractionDisplacementPointPatchVectorField Displacement by attraction to nearest point. Use in a displacementMotionSolver as a bc on the pointDisplacement field C surfaceDisplacementPointPatchVectorField Displacement fixed by projection onto triSurface . Use in a displacementMotionSolver as a bc on the pointDisplacement field C surfaceSlipDisplacementPointPatchVectorField Displacement follows a triSurface . Use in a displacementMotionSolver as a bc on the pointDisplacement field. Following is done by calculating the projection onto the surface according to the projectMode C timeVaryingMappedFixedValuePointPatchField A time-varying form of a mapped fixed value boundary condition C uniformInterpolatedDisplacementPointPatchVectorField Interpolates pre-specified motion C waveDisplacementPointPatchVectorField Foam::waveDisplacementPointPatchVectorField C heatExchangerModel Base class for heat exchanger models to handle various characteristics for the heatExchangerSource fvOption C bladeModel Blade model class calculates: C lookupProfile Profile model where polar lift and drag coefficients are linearly interpolated from a polar table by using an input angle of attack C profileModel Base class for profile models for handling aerofoil lift and drag polar diagrams C profileModelList Base class for profile models C seriesProfile Profile model where polar lift and drag coefficients are computed as sum of trigonometric series by using an input angle of attack C fixedTrim Trim model where the operating characteristics of rotor (e.g. blade pitch angle) are fixed, hence the possibility of varying thrust and torque C targetCoeffTrim Trim model where the operating characteristics of rotor (e.g. blade pitch angle) can vary to reach a specified target thrust and torque C trimModel Base class for trim models for handling blade characteristics and thrust-torque relations C tabulated6DoFAcceleration Tabulated 6DoF acceleration C genericPatchFieldBase Generic infrastructure for reading/writing unknown patch types C genericFaePatchField This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition C genericFaPatchField This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition C genericFvPatchField This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition C genericFvsPatchField This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition C genericPointPatchField A generic version of calculatedPointPatchField , useful as a fallback for handling unknown patch types C Cloud Base cloud calls templated on particle type C IOPosition Helper IO class to read and write particle coordinates (positions) C indexedParticle Adds label index to base particle C indexedParticleCloud A Cloud of particles carrying an additional index C injectedParticle Primarily stores particle properties so that it can be injected at a later time. Note that this stores its own local position as opposed to the base particle class barycentric coordinates since the particle is not (usually) attached to a mesh, and instead used for post-processing C iNew Factory class to read-construct particles (for parallel transfer) C injectedParticleCloud C InteractionLists Builds direct interaction list, specifying which local (real) cells are potentially in range of each other C referredWallFace Storage for referred wall faces. Stores patch index, face and associated points C particle Base particle class C trackingData C positionsCompat1706 Old particle positions content for OpenFOAM-1706 and earlier C iNew Factory class to read-construct particles (for parallel transfer) C passiveParticle Copy of base particle C iNew Factory class to read-construct particles (for parallel transfer) C passiveParticleCloud A Cloud of passive particles C coalCloudList C is_contiguous< coalParcel > Non-contiguous data for coalParcel C COxidationDiffusionLimitedRate Diffusion limited rate surface reaction model for coal parcels. Limited to: C COxidationHurtMitchell Char oxidation model given by Hurt and Mitchell: C COxidationIntrinsicRate Intrinsic char surface reaction mndel C COxidationKineticDiffusionLimitedRate Kinetic/diffusion limited rate surface reaction model for coal parcels. Limited to: C COxidationMurphyShaddix Limited to C(s) + O2 -> CO2 C distributionModel A library of runtime-selectable doubly-truncated probability distribution models. Returns random samples based on given distribution parameters C DSMCBaseCloud Virtual abstract base class for templated DSMCCloud C BinaryCollisionModel Templated DSMC particle collision class C WallInteractionModel Templated wall interaction model class C InflowBoundaryModel Templated inflow boundary model class C DSMCCloud Templated base class for dsmc cloud C DSMCParcel DSMC parcel class C constantProperties Class to hold DSMC particle constant properties C iNew Factory class to read-construct particles (for parallel transfer) C LarsenBorgnakkeVariableHardSphere Variable Hard Sphere BinaryCollision Model with Larsen Borgnakke internal energy redistribution. Based on the INELRS subroutine in Bird's DSMC0R.FOR C NoBinaryCollision No collison BinaryCollision Model C VariableHardSphere Variable Hard Sphere BinaryCollision Model C FreeStream Inserting new particles across the faces of a all patched of type "patch" for a free stream. Uniform values number density, temperature and velocity sourced face-by-face from the boundaryT and boundaryU fields of the cloud C NoInflow Not inserting any particles C MaxwellianThermal Wall interaction setting microscopic velocity to a random one drawn from a Maxwellian distribution corresponding to a specified temperature C MixedDiffuseSpecular Wall interaction setting microscopic velocity to a random one drawn from a Maxwellian distribution corresponding to a specified temperature for a specified fraction of collisions, and reversing the wall-normal component of the particle velocity for the remainder C SpecularReflection Reversing the wall-normal component of the particle velocity C kinematicCloud Virtual abstract base class for templated KinematicCloud C reactingCloud Virtual abstract base class for templated ReactingCloud C reactingHeterogeneousCloud Virtual abstract base class for templated ReactingCloud C reactingMultiphaseCloud Virtual abstract base class for templated reactingMultiphaseCloud C thermoCloud Virtual abstract base class for templated ThermoCloud C CollisionModel Templated collision model class C CollidingCloud Adds coolisions to kinematic clouds C cloudSolution Stores all relevant solution info for cloud C InjectionModelList List of injection models C DispersionModel Base class for dispersion modelling C PatchInteractionModel Templated patch interaction model class C SurfaceFilmModel Templated wall surface film model class C StochasticCollisionModel Templated stochastic collision model class C PackingModel Base class for packing models C DampingModel Base class for collisional damping models C IsotropyModel Base class for collisional return-to-isotropy models C KinematicCloud Templated base class for kinematic cloud C MPPICCloud Adds MPPIC modelling to kinematic clouds C CompositionModel Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids and solids C PhaseChangeModel Templated phase change model class C ReactingCloud Templated base class for reacting cloud C HeterogeneousReactingModel Base class for heterogeneous reacting models C ReactingHeterogeneousCloud Templated base class for reacting heterogeneous cloud C DevolatilisationModel Templated devolatilisation model class C SurfaceReactionModel Templated surface reaction model class C ReactingMultiphaseCloud Templated base class for multiphase reacting cloud C HeatTransferModel Templated class to calculate the fluid-particle heat transfer coefficients based on a specified Nusselt-number model C ThermoCloud Templated base class for thermodynamic cloud C IOField A primitive field of type <T> with automated input and output C integrationScheme Base for a set of schemes which integrate simple ODEs which arise from semi-implcit rate expressions C is_contiguous< basicHeterogeneousReactingParcel > Non-contiguous data for basicHeterogeneousReactingParcel C is_contiguous< basicKinematicMPPICParcel > Contiguous data for basicKinematicMPPICParcel C is_contiguous< basicKinematicParcel > Contiguous data for basicKinematicParcel C is_contiguous< basicReactingMultiphaseParcel > Non-contiguous data for basicReactingMultiphaseParcel C is_contiguous< basicReactingParcel > Non-contiguous data for basicReactingParcel C is_contiguous< basicThermoParcel > Contiguous data for basicThermoParcel C CollidingParcel Wrapper around kinematic parcel types to add collision modelling C constantProperties Class to hold thermo particle constant properties C iNew Factory class to read-construct particles (for parallel transfer) C CollisionRecordList C PairCollisionRecord Record of a collision between the particle holding the record and the particle with the stored id C WallCollisionRecord Record of a collision between the particle holding the record and a wall face at the position relative to the centre of the particle C KinematicParcel Kinematic parcel class with rotational motion (as spherical particles only) and one/two-way coupling with the continuous phase C constantProperties Class to hold kinematic particle constant properties C trackingData C iNew Factory class to read-construct particles (for parallel transfer) C AveragingMethod Base class for lagrangian averaging methods C MPPICParcel Wrapper around kinematic parcel types to add MPPIC modelling C trackingData C iNew Factory class to read-construct particles (for parallel transfer) C ReactingHeterogeneousParcel Reacting heterogeneous Parcel C constantProperties Class to hold reacting particle constant properties C iNew Factory class to read-construct particles (for parallel transfer) C ReactingMultiphaseParcel Multiphase variant of the reacting parcel class with one/two-way coupling with the continuous phase C constantProperties Class to hold reacting multiphase particle constant properties C iNew Factory class to read-construct particles (for parallel transfer) C ReactingParcel Reacting parcel class with one/two-way coupling with the continuous phase C constantProperties Class to hold reacting parcel constant properties C trackingData C iNew Factory class to read-construct particles (for parallel transfer) C ThermoParcel Thermodynamic parcel class with one/two-way coupling with the continuous phase. Includes Kinematic parcel sub-models, plus: C constantProperties Class to hold thermo particle constant properties C trackingData C iNew Factory class to read-construct particles (for parallel transfer) C phaseProperties Helper class to manage multi-specie phase properties C phasePropertiesList Simple container for a list of phase properties C CloudFunctionObject Templated cloud function object base class C CloudFunctionObjectList List of cloud function objects C FaceInteraction Face zone-based particle interactions C FacePostProcessing Records particle face quantities on used-specified face zone C FreezeParticles Sets particle active flag to false to freeze particles in space C HeatTransferCoeff Calculates and writes particle heat transfer coefficient field on the cloud C KinematicReynoldsNumber Calculates and writes particle Reynolds number field on the cloud. The normalisation factors are calculated without thermal effects C KinematicWeberNumber Calculates and writes particle Weber number field on the cloud C NusseltNumber Calculates and writes particle Nusselt number field on the cloud C ParticleCollector Function object to collect the parcel mass- and mass flow rate over a set of polygons. The polygons can either be specified by sets of user- supplied points, or in a concentric circles arrangement. If a parcel is 'collected', it can be flagged to be removed from the domain using the removeCollected entry C ParticleDose Calculate the doses absorbed by a particle as the time integral of the particle track along the radiation field G [w/m2] C ParticleErosion Creates particle erosion field, Q C ParticleHistogram Computes a histogram for the distribution of particle diameters and corresponding number of particles hitting on a given list of patches or face zones C ParticlePostProcessing Writes out various standard Lagrangian data elements of particles hitting on a given list of patches or face zones C ParticleTracks Records particle state (all variables) on each call to postFace C ParticleTrap Traps particles within a given phase fraction for multi-phase cases C particleInfoCombineOp C particleInfo C ParticleZoneInfo Reports cloud information for particles passing through a specified cell zone C PatchCollisionDensity Function object which generates fields of the number and rate of collisions per unit area on all patches. Can optionally take a minimum speed below which a collision is not counted C PatchInteractionFields Creates volume fields whose boundaries are used to store patch interaction statistics C ReactingWeberNumber Creates particle Weber number field on the cloud C RemoveParcels Removes parcels that hit user-specified face zone faces C ThermoReynoldsNumber Calculates and writes particle Reynolds number field on the cloud. The normalisation factors are calculated with thermal effects C VoidFraction Creates particle void fraction field on carrier phase C CloudSubModelBase Base class for cloud sub-models C ParticleForceList List of particle forces C MUCSheterogeneousRate Heteregeneous noncatalytic reaction MUCS approach. Reference: D. Papanastassiou and G. Bitsianes, Modelling of Heterogeneous Gas-Solid Reactions, Metallurgical Transsactions, 480. Volume 4. 1973 C NoheterogeneousReacting Dummy surface reaction model for 'none' C NoCollision Place holder for 'none' option C PairModel Templated pair interaction class C WallModel Templated wall interaction class C PairCollision C NoPair Placeholder for 'none' option C PairSpringSliderDashpot Pair forces between particles colliding with a spring, slider, damper model C WallLocalSpringSliderDashpot Forces between particles and walls, interacting with a spring, slider, damper model C WallSpringSliderDashpot Forces between particles and walls, interacting with a spring, slider, damper model C WallSiteData Stores the patch ID and templated data to represent a collision with a wall to be passed to the wall model C NoDispersion Place holder for 'none' option C CellZoneInjection Injection positions specified by a particle number density within a cell set C ConeInjection Multi-point cone injection model C ConeNozzleInjection Cone injection C FieldActivatedInjection Conditional injection at specified positions C InflationInjection Inflation injection - creates new particles by splitting existing particles within in a set of generation cells, then inflating them to a target diameter within the generation cells and an additional set of inflation cells C InjectedParticleDistributionInjection Interrogates an injectedParticleCloud to convert the raw particle data into a set of 'binned' injectors C InjectedParticleInjection Replays an set of particle data based on an injectedParticleCloud , using the assumption of one particle per parcel C InjectionModel Templated injection model class C KinematicLookupTableInjection Particle injection sources read from look-up table. Each row corresponds to an injection site C kinematicParcelInjectionData Container class to provide injection data for kinematic parcels C ManualInjection Manual injection C NoInjection Place holder for 'none' option C PatchFlowRateInjection Patch injection, by using patch flow rate to determine concentration and velocity C PatchInjection Patch injection C patchInjectionBase C CoulombForce Particle electric force model involving the Coulomb force calculation C DistortedSphereDragForce Particle-drag model wherein drag forces (per unit carrier-fluid velocity) are dynamically computed by using sphereDrag model; however, are corrected for particle distortion by linearly varying the drag between of a sphere (i.e. sphereDrag) and a value of 1.54 corresponding to a disk C ErgunWenYuDragForce Particle-drag model wherein drag forces (per unit carrier-fluid velocity) are dynamically computed based on the Gidaspow drag model which is a switch-like combination of the Wen-Yu and Ergun drag models C NonSphereDragForce Particle-drag model wherein drag forces (per unit carrier-fluid velocity) are dynamically computed based on empirical expressions using a four-parameter general drag correlation for non-spherical particles C PlessisMasliyahDragForce Particle-drag model wherein drag forces (per unit carrier-fluid velocity) are dynamically computed based on the Du Plessis-Masliyah drag model C SphereDragForce Particle-drag model wherein drag forces (per unit carrier-fluid velocity) are dynamically computed based on empirical expressions C WenYuDragForce Particle-drag model wherein drag forces (per unit carrier-fluid velocity) are dynamically computed based on the Wen-Yu drag model C forceSuSp Helper container for force Su and Sp terms C GravityForce Calculates particle gravity force C InterfaceForce Vector force apply to particles to avoid the crossing of particles from one phase to the other. The magnitude is calculated as C*mass*grad(alpha) C LiftForce Base class for particle lift force models C SaffmanMeiLiftForce Saffman-Mei particle lift force model applicable to spherical particles C TomiyamaLiftForce Tomiyama particle lift force model applicable to deformable bubbles C NonInertialFrameForce Calculates particle non-inertial reference frame force. Variable names as from Landau and Lifshitz, Mechanics, 3rd Ed, p126-129 C ParamagneticForce Calculates particle paramagnetic (magnetic field) force C ParticleForce Abstract base class for particle forces C PressureGradientForce Calculates particle pressure gradient force C SRFForce Calculates particle SRF reference frame force C TomiyamaDragForce Particle-drag model wherein drag forces (per unit carrier-fluid velocity) are dynamically computed using empirical expressions based on their level of contamination C VirtualMassForce Calculates particle virtual mass force C LocalInteraction Patch interaction specified on a patch-by-patch basis C patchInteractionData Helper class for the LocalInteraction patch interaction model C patchInteractionDataList List container for patchInteractionData class C MultiInteraction Runs multiple patch interaction models in turn. Takes dictionary where all the subdictionaries are the interaction models C NoInteraction Dummy class for 'none' option - will raise an error if any functions are called that require return values C Rebound Simple rebound patch interaction model C RecycleInteraction Patch interaction model to perform parcel transfer and recycle from one patch to another C StandardWallInteraction Wall interaction model C NoStochasticCollision Dummy collision model for 'none' C KinematicSurfaceFilm Kinematic parcel surface film model C NoSurfaceFilm Place holder for 'none' option C CorrectionLimitingMethod Base class for correction limiting methods C ParticleStressModel Base class for inter-particle stress models C TimeScaleModel Base class for time scale models C NoComposition Dummy class for 'none' option - will raise an error if any functions are called that require return values C SingleMixtureFraction Templated parcel multi-phase, multi-component class C SinglePhaseMixture Templated parcel single phase, multi-component class C ReactingLookupTableInjection Particle injection sources read from look-up table. Each row corresponds to an injection site C reactingParcelInjectionData Container class to provide injection data for reacting parcels C LiquidEvapFuchsKnudsen Liquid evaporation/condensation model for solution of liquid and solid C LiquidEvaporation Liquid evaporation model C LiquidEvaporationBoil Liquid evaporation model C NoPhaseChange Dummy phase change model for 'none' C ConstantRateDevolatilisation Constant rate devolatisation model C NoDevolatilisation Dummy devolatilisation model for 'none' C SingleKineticRateDevolatilisation Single kinetic rate devolatisation model C ReactingMultiphaseLookupTableInjection Particle injection sources read from look-up table. Each row corresponds to an injection site C reactingMultiphaseParcelInjectionData Container class to provide injection data for reacting multiphase parcels C SuppressionCollision Inter-cloud collision model, whereby the canReact flag can be used to inhibit devolatilisation and surface reactions C NoSurfaceReaction Dummy surface reaction model for 'none' C NoHeatTransfer Nusselt-number model providing an interface to the properties of HeatTransferModel C RanzMarshall Nusselt-number model using the empirical Ranz-Marshall correlation to be used in modelling of the fluid-particle heat transfer coefficient: C ThermoLookupTableInjection Particle injection sources read from look-up table. Each row corresponds to an injection site C thermoParcelInjectionData Container class to provide injection data for thermodynamic parcels C ThermoSurfaceFilm Thermo parcel surface film model C bufferedAccumulator C correlationFunction C distribution Accumulating histogram of values. Specified bin resolution automatic generation of bins C molecule Foam::molecule C constantProperties Class to hold molecule constant properties C trackingData Class used to pass tracking data to the trackToFace function C iNew Factory class to read-construct particles (for parallel transfer) C moleculeCloud C reducedUnits C electrostaticPotential C energyScalingFunction C pairPotential C pairPotentialList C potential C tetherPotential C tetherPotentialList C solidParticle Simple solid spherical particle class with one-way coupling with the continuous phase C trackingData Class used to pass tracking data to the trackToFace function C iNew Factory class to read-construct particles (for parallel transfer) C is_contiguous< solidParticle > Contiguous data for solidParticle C solidParticleCloud A Cloud of solid particles C sprayCloud Virtual abstract base class for templated SprayCloud C AtomizationModel Templated atomization model class C BreakupModel Templated break-up model class C SprayCloud Templated base class for spray cloud C is_contiguous< basicSprayParcel > Non-contiguous data for basicSprayParcel C SprayParcel Reacting spray parcel, with added functionality for atomization and breakup C constantProperties Class to hold reacting particle constant properties C iNew Factory class to read-construct particles (for parallel transfer) C BlobsSheetAtomization Primary Breakup Model for pressure swirl atomizers C LISAAtomization Primary Breakup Model for pressure swirl atomizers C NoAtomization Dummy phase change model for 'none' C ETAB The Enhanced TAB model C NoBreakup Dummy breakup model for 'none' C PilchErdman Particle secondary breakup model based on Pilch-Erdman total droplet breakup model C ReitzDiwakar Secondary breakup model C ReitzKHRT Secondary breakup model which uses the Kelvin-Helmholtz instability theory to predict the 'stripped' droplets... and the Raleigh-Taylor instability as well C SHF Secondary Breakup Model to take account of the different breakup regimes, bag, molutimode, shear... C TAB The TAB Method for Numerical Calculation of Spray Droplet Breakup C ORourkeCollision Collision model by P.J. O'Rourke C TrajectoryCollision Trajectory collision model by N. Nordin, based on O'Rourke's collision model C DispersionRASModel Base class for particle dispersion models based on RAS turbulence C GradientDispersionRAS The velocity is perturbed in the direction of -grad(k), with a Gaussian random number distribution with variance sigma. where sigma is defined below C StochasticDispersionRAS The velocity is perturbed in random direction, with a Gaussian random number distribution with variance sigma. where sigma is defined below C BrownianMotionForce Calculates particle Brownian motion force C Map A HashTable to objects of type <T> with a label key C lumpedPointController Simple connectivity of point labels to specify a controller for lumped point movement C lumpedPointInterpolator A simple linear interpolator between two locations, which are referenced by index C lumpedPointIOMovement IO-registered version of lumpedPointMovement C lumpedPointMovement The movement driver that describes initial point locations, the current state of the points/rotations, and forwarding to the externalFileCoupler communication coordinator C lumpedPointDisplacementPointPatchVectorField This is the point-patch responsible for managing the force integration on a 'lumped-point' basis, waiting for the external application, reading back the response from the external program and updating the locations of the associated patch points accordingly C lumpedPointState The state of lumped points corresponds to positions and rotations C blockDescriptor Takes the description of the block and the list of curved edges and creates a list of points on edges together with the weighting factors C blockEdge Define a curved edge that is parameterized for 0<lambda<1 between the start/end points C iNew Class used for the read-construction of C BSpline An implementation of B-splines C lineDivide Divides a line into segments C polyLine A series of straight line segments, which can also be interpreted as a series of control points for splines, etc C CatmullRomSpline An implementation of Catmull-Rom splines (sometimes known as Overhauser splines) C blockFace Define a curved face C iNew Class used for the read-construction of C blockMesh A multi-block mesh generator C block Creates a single block of cells from point coordinates, numbers of cells in each direction and an expansion ratio C iNew Class used for the read-construction of C blockVertex Define a block vertex C iNew Class used for the read-construction of C gradingDescriptor Handles the specification for grading within a section of a block C gradingDescriptors List of gradingDescriptor for the sections of a block with additional IO functionality C PDRblock A single block x-y-z rectilinear mesh addressable as i,j,k with simplified creation. Some of the input is similar to blockMeshDict, but since this specialization is for a single-block that is aligned with the x-y-z directions, it provides a different means of specifying the mesh C location Grid locations in an axis direction C gridControl The begin/end nodes for each segment, with divisions and expansion for each segment C extrudeModel Top level extrusion model class C displacementMeshMoverMotionSolver Mesh motion solver for an fvMesh . Uses externalDisplacementMeshMover to do the mesh motion C adddisplacementMotionSolverMeshMoverToDebug C displacementMotionSolverMeshMover Quality-based under-relaxation wrapped around generic displacementMotionSolver C externalDisplacementMeshMover Virtual base class for mesh movers with externally provided displacement field giving the boundary conditions. Move the mesh from the current location to a new location (so modify the mesh; v.s. motionSolver that only returns the new location) C addfieldSmootherToDebug C fieldSmoother Utility functions for mesh motion solvers C PointData Variant of pointEdgePoint with some transported additional data. Templated on the transported data type C medialAxisMeshMover Mesh motion solver that uses a medial axis algorithm to work out a fraction between the (nearest point on a) moving surface and the (nearest point on a) fixed surface C addmeshRefinementToDebug C meshRefinement Helper class which maintains intersections of (changing) mesh with (static) surfaces C normalLess To compare normals C pTraits< labelList > Template specialization for pTraits<labelList> so we can have fields C pTraits< vectorList > Template specialization for pTraits<vectorList> so we can have fields C patchFaceOrientation Transport of orientation for use in PatchEdgeFaceWave C is_contiguous< patchFaceOrientation > Contiguous data for patchFaceOrientation C is_contiguous_label< patchFaceOrientation > Contiguous label data for patchFaceOrientation C transportData Holds information (coordinate and distance). Walks out 0.5*distance C trackData Class used to pass additional data in C is_contiguous< transportData > Contiguous data for transportData C wallPoints For use with FaceCellWave . Determines topological distance to starting faces C trackData Class used to pass additional data in C pTraits< weightedPosition > PTraits C weightedPosition Wrapper for position + weight to be used in e.g. averaging C refinementFeatures Encapsulates queries for features C refinementSurfaces Container for data on surfaces used for surface-driven refinement. Contains all the data about the level of refinement needed per surface C surfaceZonesInfo C shellSurfaces Encapsulates queries for volume refinement ('refine all cells within shell') C layerParameters Simple container to keep together layer specific information C PointIntegrateData Integrate along selected edges using PointEdgeWave C trackingData Class used to pass extra data C is_contiguous< PointIntegrateData< DataType > > Data are contiguous if the data type is contiguous C refinementParameters Simple container to keep together refinement specific information C snapParameters Simple container to keep together snap specific information C snappyLayerDriver All to do with adding layers C snappyRefineDriver C snappySnapDriver All to do with snapping to surface C listPlusEqOp C snappyVoxelMeshDriver Equivalent of snappyRefineDriver but operating on a voxel mesh C trackedParticle Particle class that marks cells it passes through. Used to mark cells visited by feature edges C trackingData Class used to pass tracking data to the trackToFace function C iNew Factory class to read-construct particles (for parallel transfer) C is_contiguous< trackedParticle > Contiguous data for trackedParticle C combine C interpolate C FaceCellWaveBase C FaceCellWave Wave propagation of information through grid. Every iteration information goes through one layer of cells. Templated on information that is transferred C MeshWave FaceCellWave plus data C edgeTopoDistanceData For use with PatchEdgeFaceWave . Determines topological distance to starting edges. Templated on passive transported data C is_contiguous< edgeTopoDistanceData< Type, PrimitivePatchType > > Data are contiguous if data type is contiguous C is_contiguous_label< edgeTopoDistanceData< Type, PrimitivePatchType > > Data are contiguous label if data type is label C is_contiguous_scalar< edgeTopoDistanceData< Type, PrimitivePatchType > > Data are contiguous scalar if data type is scalar C patchEdgeFaceInfo C is_contiguous< patchEdgeFaceInfo > Contiguous data for patchEdgeFaceInfo C is_contiguous_scalar< patchEdgeFaceInfo > Contiguous scalar data for patchEdgeFaceInfo C patchEdgeFaceRegion Transport of region for use in PatchEdgeFaceWave C is_contiguous< patchEdgeFaceRegion > Contiguous data for patchEdgeFaceRegion C is_contiguous_label< patchEdgeFaceRegion > Contiguous label data for patchEdgeFaceRegion C patchEdgeFaceRegions Transport of regions for use in PatchEdgeFaceWave C PatchEdgeFaceWaveBase C PatchEdgeFaceWave Wave propagation of information along patch. Every iteration information goes through one layer of faces. Templated on information that is transferred C updateOp Update operation C transformOp Transform operation C patchPatchDist Like wallDist but calculates on a patch the distance to nearest neighbouring patches. Uses PatchEdgeFaceWave to do actual calculation C is_contiguous< PointData< DataType > > Data are contiguous if data type is contiguous C is_contiguous_scalar< PointData< DataType > > Contiguous scalar only when data type is also scalar C pointEdgePoint Holds information regarding nearest wall point. Used in PointEdgeWave . (so not standard FaceCellWave ) To be used in wall distance calculation C is_contiguous< pointEdgePoint > Contiguous data for pointEdgePoint C is_contiguous_scalar< pointEdgePoint > Contiguous scalar data for pointEdgePoint C combineEqOp Reduction class. If x and y are not equal assign value C PointEdgeWaveBase C PointEdgeWave Wave propagation of information through grid. Every iteration information goes through one layer of edges C listUpdateOp List update operation C advancingFrontAMI Base class for Arbitrary Mesh Interface (AMI) methods C AMICache Provides caching of weights and addressing to AMIInterpolation C AMIInterpolation Interpolation class dealing with transfer of data between two primitive patches with an arbitrary mesh interface (AMI) C faceAreaWeightAMI Face area weighted Arbitrary Mesh Interface (AMI) method C faceAreaWeightAMI2D Face area weighted Arbitrary Mesh Interface (AMI) method that performs the intersection of src and tgt face area in 2D C findNearestMaskedOp C nearestFaceAMI Nearest-face Arbitrary Mesh Interface (AMI) method C nearestEqOp Helper class for finding nearest C faceAreaIntersect Face intersection class C cyclicACMIGAMGInterfaceField GAMG agglomerated cyclic interface for Arbitrarily Coupled Mesh Interface (ACMI) fields C cyclicAMIGAMGInterfaceField GAMG agglomerated cyclic interface field C cyclicACMIGAMGInterface GAMG agglomerated cyclic ACMI interface C cyclicAMIGAMGInterface GAMG agglomerated cyclic AMI interface C cyclicACMILduInterface An abstract base class for cyclic ACMI coupled interfaces C cyclicACMILduInterfaceField Abstract base class for cyclic ACMI coupled interfaces C cyclicACMIPointPatch Cyclic AMI point patch - place holder only C cyclicACMIPointPatchField Cyclic ACMI front and back plane patch field C cyclicACMIPolyPatch Cyclic patch for Arbitrarily Coupled Mesh Interface (ACMI) C cyclicAMILduInterface An abstract base class for cyclic AMI coupled interfaces C cyclicAMILduInterfaceField Abstract base class for cyclic AMI coupled interfaces C cyclicAMIPointPatch Cyclic AMI point patch - place holder only C cyclicAMIPointPatchField Cyclic AMI front and back plane patch field C cyclicAMIPolyPatch Cyclic patch for Arbitrary Mesh Interface (AMI) C cyclicPeriodicAMIPolyPatch Cyclic patch for periodic Arbitrary Mesh Interface (AMI) C triangle2D 2-D triangle and queries C cellClassification 'Cuts' a mesh with a surface C cellInfo Holds information regarding type of cell. Used in inside/outside determination in cellClassification C is_contiguous< cellInfo > Contiguous data for cellInfo C is_contiguous_label< cellInfo > Contiguous label data for cellInfo C cellDistFuncs Collection of functions used in wall distance calculation C directionalWallPointData Holds information (coordinate and normal) regarding the nearest wall point C is_contiguous< directionalWallPointData< bool > > C is_contiguous< directionalWallPointData< label > > C is_contiguous< directionalWallPointData< scalar > > C patchDataWave Takes a set of patches to start MeshWave from C patchWave Takes a set of patches to start MeshWave from. After construction holds distance at cells and distance at patches. Is e.g. used by wallDist to construct volScalarField with correct distance to wall C wallPoint Holds information regarding nearest wall point. Used in wall distance calculation C is_contiguous< wallPoint > Contiguous data for wallPoint C is_contiguous_scalar< wallPoint > Contiguous scalar data for wallPoint C wallPointData Holds information (coordinate and normal) regarding nearest wall point C is_contiguous< wallPointData< Type > > Data are contiguous if data type is contiguous C is_contiguous_label< wallPointData< Type > > Data are contiguous label if data type is label C is_contiguous_scalar< wallPointData< Type > > Data are contiguous scalar if data type is scalar C cellFeatures Cell analysis class C cellQuality Class calculates cell quality measures C coordSet Holds list of sampling positions C coordSetWriter Base class for writing coordSet(s) and tracks with fields C externalFileCoupler Encapsulates the logic for coordinating between OpenFOAM and an external application C edgeFaceCirculator Walks from starting face around edge C extendedEdgeMesh Description of feature edges and points C extendedFeatureEdgeMesh ExtendedEdgeMesh + IO C is_globalIOobject< extendedFeatureEdgeMesh > Global file type for extendedFeatureEdgeMesh C featureEdgeMesh EdgeMesh + IO C is_globalIOobject< featureEdgeMesh > Global file type for featureEdgeMesh C uniformFixedValuePointPatchField Enables the specification of a uniform fixed value condition C polyGeoMesh The polyMesh GeoMesh for holding internal fields without an fvMesh C DimensionedField Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a reference to it is maintained C curve A single curve in a graph C curveStyle The style (line, symbol, etc) of a curve C graph Class to create, store and output qgraph files C writer Abstract base class for a graph writer C treeDataFace Encapsulation of data for searching on faces C findNearestOp C findIntersectOp C indexedOctree Non-pointer based hierarchical recursive searching C treeDataPrimitivePatch Encapsulation of data needed to search on PrimitivePatches C findNearestOp C findIntersectOp C findAllIntersectOp C findSelfIntersectOp C mappedPointPatch MappedPointPatch patch C mappedWallPointPatch MappedWallPointPatch patch C mappedPatchBase Determines a mapping between patch face centres and mesh cell or face centres and processors they're on C nearestEqOp C maxProcEqOp C nearestWorldEqOp C mappedPolyPatch Determines a mapping between patch face centres and mesh cell or face centres and processors they're on C mappedVariableThicknessWallPolyPatch Foam::mappedVariableThicknessWallPolyPatch C mappedWallPolyPatch Determines a mapping between patch face centres and mesh cell or face centres and processors they're on C distributedDICPreconditioner Version of DICpreconditioner that uses preconditioning across processor (and coupled) boundaries. Based on 'Parallel Preconditioners' chapter from 'Iterative Methods for Sparse Linear Systems' by Yousef Saad C distributedDILUPreconditioner Version of DILUpreconditioner that uses preconditioning across processor (and coupled) boundaries. Based on 'Parallel Preconditioners' chapter from 'Iterative Methods for Sparse Linear Systems' by Yousef Saad C processorColour Colouring processors such that no neighbours have the same colour C findUniqueIntersectOp C meshSearch Various (local, not parallel) searches on polyMesh ; uses (demand driven) octree to search C meshSearchFACE_CENTRE_TRISMeshObject MeshObject wrapper around meshSearch(mesh, polyMesh::FACE_CENTRE_TRIS) C meshSearchMeshObject MeshObject wrapper around meshSearch(mesh) C meshStructure Detect extruded mesh structure given a set of faces (uindirectPrimitivePatch ) C pointTopoDistanceData For use with PointEdgeWave . Determines topological distance to starting points. Templated on passive transported data C is_contiguous< pointTopoDistanceData< Type > > Data are contiguous if data type is contiguous C is_contiguous_label< pointTopoDistanceData< Type > > Data are contiguous label if data type is label C is_contiguous_scalar< pointTopoDistanceData< Type > > Data are contiguous scalar if data type is scalar C topoDistanceData For use with FaceCellWave . Determines topological distance to starting faces. Templated on passive transported data C is_contiguous< topoDistanceData< Type > > Data are contiguous if data type is contiguous C is_contiguous_label< topoDistanceData< Type > > Data are contiguous label if data type is label C is_contiguous_scalar< topoDistanceData< Type > > Data are contiguous scalar if data type is scalar C momentOfInertia Calculates the inertia tensor and principal axes and moments of a polyhedra/cells/triSurfaces. Inertia can either be of the solid body or of a thin shell C worldConnectBitOrEq C multiWorldConnections Centralized handling of multi-world MPI connections C coordinateScaling Helper class to wrap coordinate system and component-wise scaling C PatchFunction1 Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits C patchFunction1Base Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits C polyAddCell Class containing data for cell addition C polyAddFace A face addition data class. A face can be inflated either from a point or from another face and can either be in internal or a boundary face C polyAddPoint Class containing data for point addition C polyModifyCell Class describing modification of a cell C polyModifyFace Class describing modification of a face C polyModifyPoint Class describing modification of a point C CompactListList A packed storage of objects of type <T> using an offset table for access C polyTopoChange Direct mesh changes based on v1.3 polyTopoChange syntax C polyRemoveCell Class containing data for cell removal C polyRemoveFace Class containing data for face removal C polyRemovePoint Class containing data for point removal C topoAction A virtual base class for topological actions C primitiveMeshGeometry Updateable mesh geometry + checking routines C processorLOD Base class to generate a parallel distribution map for sending sufficient target objects to cover a description of the source object, based on processor Level Of Detail (LOD) shapes C regionProperties Simple class to hold region information for coupled region simulations C minEqOpFace C localPointRegion Takes mesh with 'baffles' (= boundary faces sharing points). Determines for selected points on boundary faces the 'point region' it is connected to. Each region can be visited by a cell-face-cell walk. Used in duplicating points after splitting baffles C minData For use with FaceCellWave . Transports minimum passive data C is_contiguous< minData > Contiguous data for minData C is_contiguous_label< minData > Contiguous label data for minData C regionSplit This class separates the mesh into distinct unconnected regions, each of which is then given a label according to globalNumbering() C regionSplit2D Splits a patch into regions based on a mask field. Result is a globally consistent label list of region index per patch face C closedTriSurfaceMesh A triSurfaceMesh where it is forced to check volumeTypes, used for surfaces that are topologically non-manifold (small holes or multiple parts) but are geometrically essentially closed C searchableBox Searching on bounding box C searchableCone Searching on (optionally hollow) cone C searchableCylinder Searching on a cylinder C searchableDisk Searching on circular disk given as origin, normal (gets normalised) and radius. Optionally it can be an annular ring C searchableExtrudedCircle Searching on edgeMesh with constant radius C searchablePlane Searching on (infinite) plane. The dictionary specifications are identical to the Foam::plane requirements C searchablePlate Searching on finite plate. Plate has to be aligned with coordinate axes. Plate defined as origin and span. One of the components of span has to be 0 which defines the normal direction. E.g C searchableRotatedBox Searching on a rotated box C searchableSphere Searching on general spheroid C searchableSurface Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP C iNew Class used for the read-construction of C is_globalIOobject< searchableSurface > Global file type for searchableSurface C searchableSurfaceCollection Set of transformed searchableSurfaces . Does not do boolean operations so when meshing might find parts 'inside' C searchableSurfaces Container for searchableSurfaces . The collection is specified as a dictionary. For example, C searchableSurfacesQueries A collection of tools for searchableSurfaces C searchableSurfaceWithGaps SearchableSurface using multiple slightly shifted underlying surfaces to make sure pierces don't go through gaps: C subTriSurfaceMesh On-the-fly subset of triSurfaceMesh (based on selected patches) C addsmoothTriSurfaceMeshToDebug C smoothTriSurfaceMesh Variant of triSurfaceMesh that interpolates face-normals to obtain point normals C addtriSurfaceMeshToDebug C triSurfaceMesh IOoject and searching on triSurface C is_globalIOobject< triSurfaceMesh > Global file type for triSurfaceMesh C solidBodyMotionFunction Base class for defining solid-body motions C surfaceSets Various utilities to handle sets relating mesh to surface. Note: work in progress. Used in meshing tools C tetOverlapVolume Calculates the overlap volume of two cells using tetrahedral decomposition C boundaryToCell A topoSetCellSource C boxToCell A topoSetCellSource C cellToCell A topoSetCellSource cellSet(s) or cellZone(s) C clipPlaneToCell A topoSetCellSource C cylinderAnnulusToCell A topoSetCellSource C cylinderToCell A topoSetCellSource C faceToCell A topoSetCellSource faceSet(s), e.g. select cells that are the owner/neighbour/any of the faces in a given faceSet C faceZoneToCell A topoSetCellSource front or back side of given faceZone(s) C fieldDictionary Read field as dictionary (without mesh) C fieldToCell A topoSetCellSource volScalarField C haloToCell A topoSetCellSource cellSet cellSet C labelToCell A topoSetCellSource C nbrToCell A topoSetCellSource N or less number of neighbouring cells (i.e. number of internal or coupled faces) C nearestToCell A topoSetCellSource C patchToCell A topoSetCellSource C pointToCell A topoSetCellSource pointSet(s) C regionToCell A topoSetCellSource subCellSet keeps to it; if started outside stays outside C rotatedBoxToCell A topoSetCellSource C searchableSurfaceToCell A topoSetCellSource searchableSurface C shapeToCell A topoSetCellSource C sphereToCell A topoSetCellSource C surfaceToCell A topoSetCellSource C targetVolumeToCell A topoSetCellSource C topoSetCellSource The topoSetCellSource topoSet C zoneToCell A topoSetCellSource cellZone(s) to a cellSet C setToCellZone A topoSetSource cellSet cellZone cellSet C topoSetCellZoneSource The topoSetCellZoneSource topoSet C boundaryToFace A topoSetFaceSource C boxToFace A topoSetFaceSource C cellToFace A topoSetFaceSource cellSet(s) C clipPlaneToFace A topoSetFaceSource C cylinderAnnulusToFace A topoSetFaceSource C cylinderToFace A topoSetFaceSource C faceToFace A topoSetFaceSource faceSet C holeToFace A topoSetFaceSource to select a set of faces that closes a hole i.e. disconnects zones (specified by locations) from one another C labelToFace A topoSetFaceSource C normalToFace A topoSetFaceSource C patchToFace A topoSetFaceSource C pointToFace A topoSetFaceSource pointSet(s) C regionToFace A topoSetFaceSource C searchableSurfaceToFace A topoSetFaceSource searchableSurface C sphereToFace A topoSetFaceSource C topoSetFaceSource The topoSetFaceSource topoSet C zoneToFace A topoSetFaceSource faceZone(s) to a faceSet C cellToFaceZone A topoSetSource cellSet C faceZoneToFaceZone A topoSetSource faceZone C planeToFaceZone A topoSetSource C searchableSurfaceToFaceZone A topoSetSource searchableSurface C setAndNormalToFaceZone A topoSetSource faceSet C setsToFaceZone A topoSetSource faceSet cellSet C setToFaceZone A topoSetSource faceSet faceZone faceSet C topoSetFaceZoneSource The topoSetFaceZoneSource topoSet C boxToPoint A topoSetPointSource C cellToPoint A topoSetPointSource cellSet(s) C clipPlaneToPoint A topoSetPointSource C cylinderToPoint A topoSetPointSource C faceToPoint A topoSetPointSource faceSet(s) C labelToPoint A topoSetPointSource C nearestToPoint A topoSetPointSource C patchToPoint A topoSetPointSource C pointToPoint A topoSetPointSource pointSet(s) C searchableSurfaceToPoint A topoSetPointSource searchableSurface C sphereToPoint A topoSetPointSource C surfaceToPoint A topoSetPointSource C topoSetPointSource The topoSetPointSource topoSet C zoneToPoint A topoSetPointSource pointZone(s) to a pointSet C setToPointZone A topoSetSource pointSet pointZone pointSet C topoSetPointZoneSource The topoSetPointZoneSource topoSet C cellBitSet A special purpose topoSet with the cell labels stored as a bitSet . It does not correspond to a cellSet either (no associated IOobject ) C cellSet A collection of cell labels C cellZoneSet Like cellSet but -reads data from cellZone -updates cellZone when writing C faceBitSet A special purpose topoSet with the face labels stored as a bitSet . It does not correspond to a faceSet either (no associated IOobject ) C faceBoolSet A special purpose topoSet with the face labels stored as a boolList . It does not correspond to a faceSet either (no associated IOobject ) C faceSet A list of face labels C faceZoneSet Like faceSet but -reads data from faceZone -updates faceZone when writing C pointBitSet A special purpose topoSet with the point labels stored as a bitSet . It does not correspond to a pointSet either (no associated IOobject ) C pointSet A set of point labels C pointZoneSet Like pointSet but -reads data from pointZone -updates pointZone when writing C topoBitSet Base for a special purpose topoSet using labels stored as a bitSet C topoBoolSet Base for a special purpose topoSet using labels stored as a boolList C topoSet General set of labels of mesh quantity (points, cells, faces) C topoSetSource Base class of a source for a topoSet C addToUsageTable Class with constructor to add usage string to table C iNew Class used for the read-construction of C triangulatedPatch Performs a triangulation of a patch to return randomised point locations C booleanSurface Surface-surface intersection. Given two surfaces construct combined surface C edgeSurface Description of surface in form of 'cloud of edges' C intersectedSurface Given triSurface and intersection creates the intersected (properly triangulated) surface. (note: intersection is the list of points and edges 'shared' by two surfaces) C edgeIntersections Holder of intersections of edges of a surface with another surface. Optionally shuffles around points on surface to resolve any 'conflicts' (edge hitting triangle edge, edge hitting point etc.) C surfaceIntersection Basic surface-surface intersection description. Constructed from two surfaces it creates a description of the intersection C faceTriangulation Triangulation of faces. Handles concave polygons as well (inefficiently) C orientedSurface Given point flip all faces such that normals point in same direction C surfaceFeatures Holds feature edges/points of surface C surfaceLocation Contains information about location on a triSurface C triangleFuncs Contains various triangle static functions C triSurfaceLoader Convenience class for loading single or multiple surface files from the constant/triSurface (or other) directory C triSurfaceRegionSearch Helper class to search on triSurface . Creates an octree for each region of the surface and only searches on the specified regions C triSurfaceSearch Helper class to search on triSurface C pointToPointPlanarInterpolation Interpolates between two sets of unstructured points using 2D Delaunay triangulation. Used in e.g. timeVaryingMapped bcs C MeshedSurface A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMesh , which actually refers to the cell faces of a volume mesh C triSurfaceTools A collection of tools for triSurface C twoDPointCorrector Class applies a two-dimensional correction to mesh motion point field C adaptiveSolver C Euler Euler-implicit integration scheme C EulerSI Semi-implicit Euler ODE solver of order (0)1 C ODESolver Abstract base-class for ODE system solvers C stepState C RKCK45 4/5th Order Cash-Karp Runge-Kutta ODE solver C RKDP45 4/5th Order Dormand-Prince Runge-Kutta ODE solver C RKF45 4/5th Order Runge-Kutta-Fehlberg ODE solver C rodas23 L-stable, stiffly-accurate embedded Rosenbrock ODE solver of order (2)3 C rodas34 L-stable, stiffly-accurate embedded Rosenbrock ODE solver of order (3)4 C Rosenbrock12 L-stable embedded Rosenbrock ODE solver of order (1)2 C Rosenbrock23 L-stable embedded Rosenbrock ODE solver of order (2)3 C Rosenbrock34 L-stable embedded Rosenbrock ODE solver of order (3)4 C seulex An extrapolation-algorithm, based on the linearly implicit Euler method with step size control and order selection C SIBS A semi-implicit mid-point solver for stiff systems of ordinary differential equations C Trapezoid Trapezoidal ODE solver of order (1)2 C ODESystem Abstract base class for the systems of ordinary differential equations C AABBTree Templated tree of axis-aligned bounding boxes (AABB) C AABBTreeBase Template invariant parts for AABBTree C dynamicIndexedOctree Non-pointer based hierarchical recursive searching. Storage is dynamic, so elements can be deleted C dynamicIndexedOctreeBase Template invariant parts for dynamicIndexedOctree C dynamicTreeDataPoint Holds (reference to) pointField . Encapsulation of data needed for octree searches. Used for searching for nearest point. No bounding boxes around points. Only overlaps and calcNearest are implemented, rest makes little sense C indexedOctreeBase Template invariant parts for indexedOctree C node Tree node. Has up pointer and down pointers C labelBits A 29bits (or 61bits) integer label with 3bits direction (eg, octant) packed into single label C treeDataCell Encapsulation of data needed to search in/for cells. Used to find the cell containing a point (e.g. cell-cell mapping) C findNearestOp C findIntersectOp C treeDataEdge Holds data for octree to work on an edges subset C findNearestOp Forward to treeDataEdge findNearest operations C findIntersectOp Forward to treeDataEdge findIntersect operations C treeDataPoint Holds (reference to) pointField . Encapsulation of data needed for octree searches. Used for searching for nearest point. No bounding boxes around points. Only overlaps and calcNearest are implemented, rest makes little sense C findNearestOp Forward to treeDataPoint findNearest operations C findIntersectOp Forward to treeDataPoint findIntersect operations (not possible) C subCycleField C subCycle Perform a subCycleTime on a field C List A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bounds checking, etc C bitSet A bitSet stores bits (elements with only two states) in packed internal format and supports a variety of bit-set operations. Its behaviour is largely list-like, with some HashSet features C reference A reference supporting read/write access to an entry C const_iterator A const_iterator for iterating across on values C Hash< bitSet > Hashing for bitSet data C PackedList A dynamic list of packed unsigned integers, with the number of bits per item specified by the <Width> template parameter C reference A reference supporting read/write access to an entry C hasher Hashing functor for PackedList C Hash< PackedList< Width > > Hashing for PackedList data C CircularBuffer A simple list of objects of type <T> that is intended to be used as a circular buffer (eg, a FIFO) when the alloc/free overhead associated with a linked-list approach is to be avoided C const_iterator A simple forward const iterator for a circular buffer C CirculatorBase Template-invariant parts for circulators C CirculatorIters A pair of begin/end iterators used for implementing circular iteration C Circulator Walks over a container as if it were circular. The container must have the following members defined: C ConstCirculator Like Foam::Circulator , but with const-access iterators C Dictionary General purpose template dictionary class that manages the storage associated with it C DictionaryBase Base dictionary class templated on both the form of doubly-linked list it uses as well as the type it holds C PtrDictionary Template dictionary class which manages the storage associated with it C PtrListDictionary Template dictionary class which manages the storage associated with it C UDictionary Template dictionary class which does not manages the storage associated with it C UPtrDictionary Template dictionary class which does not manages the storage associated with it C autoPtr Pointer management similar to std::unique_ptr, with some additional methods and type checking C refPtr A class for managing references or pointers (no reference counting) C tmp A class for managing temporary objects C HashPtrTable A HashTable of pointers to objects of type <T>, with deallocation management of the pointers C MinMax A min/max value pair with additional methods. In addition to conveniently storing values, it can be used for logic operations or to modify data. A few global functions and functors are also provided C HashSet A HashTable with keys but without contents that is similar to std::unordered_set C UList A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscript bounds checking, etc C less A list compare binary predicate for normal sort C greater A list compare binary predicate for reverse sort C hasher Hashing functor for UList C Hash Deprecated(2021-04) hashing functor. Use hasher() C UPtrList A list of pointers to objects of type <T>, without allocation/deallocation management of the pointers - this is to be done elsewhere. The operator[] returns a reference to the object (not the pointer) C value_compare A wrapper for a binary comparison of values that interjects pointer dereferencing with null pointer guards C less A UPtrList compare binary predicate for normal sort order. Null entries (if any) sort to the end C greater A UPtrList compare binary predicate for reverse sort order C Iterator Internally used base for iterator and const_iterator C iterator Forward iterator with non-const access C const_iterator Forward iterator with const access C FixedList A 1D vector of objects of type <T> with a fixed length <N> C hasher Hashing functor for FixedList C Hash Deprecated(2021-04) hashing functor. Use hasher() C HashTable A HashTable similar to std::unordered_map C Iterator Internally used base for iterator and const_iterator C iterator Forward iterator with non-const access C const_iterator Forward iterator with const access C key_iterator_base An iterator wrapper for returning a reference to the key C HashTableCore Bits that are independent of HashTable template parameters C const_iterator_pair Factory class for creating a begin/end pair for any const iterator type, normally associated with a HashTable C PtrMap A HashTable of pointers to objects of type <T> with a label key C LabelledItem A container with an integer index that can be attached to any item. The index may be useful for sorting or storing additional information C BiIndirectList Indexes into negList (negative index) or posList (zero or positive index) C IndirectList A List with indirect addressing C IndirectListAddressing A class for storing list addressing (labels, slices etc), which are normally to used by IndirectList . Private inheritance is often used by any inheriting classes C IndirectListBase Base for lists with indirect addressing, templated on the list contents type and the addressing type. Storage for both values and addressing is held outside of the class C iterator A non-const iterator for an indirect list C const_iterator A const iterator for an indirect list C IndirectSubList Indirect access to a sub-section of a list C SliceList A List with indirect slice addressing C SortList An indirect list with addressing based on sorting. The list is sorted upon construction or when explicitly requested C ILList Template class for intrusive linked lists C LList Template class for non-intrusive linked lists C link The storage of T with linked nodes C iterator An STL-conforming iterator C const_iterator An STL-conforming const_iterator C reverse_iterator A reverse_iterator , for LListBase classes that support reverse iteration C const_reverse_iterator A const_reverse_iterator , for LListBase classes that support reverse iteration C LPtrList Template class for non-intrusive linked PtrLists C iterator An STL-conforming iterator C const_iterator An STL-conforming const_iterator C reverse_iterator A reverse_iterator , for base classes that support reverse iteration C const_reverse_iterator A const_reverse_iterator , for base classes that support reverse iteration C UILList Template class for intrusive linked lists C iterator A non-const iterator C const_iterator A const_iterator C reverse_iterator A reverse_iterator , for LListBase classes that support reverse iteration C const_reverse_iterator A const_reverse_iterator , for LListBase classes that support reverse iteration C DLListBase Base for doubly-linked lists C link The structure for a doubly-linked storage node C iterator A primitive non-const node iterator C const_iterator A primitive const node iterator (bidirectional) C SLListBase Base for singly-linked lists C link The structure for a singly-linked storage node C iterator A primitive non-const node iterator C const_iterator A primitive const node iterator C FIFOStack A FIFO stack based on a singly-linked list C LIFOStack A LIFO stack based on a singly-linked list C BinSum Sums into bins C Distribution Accumulating histogram of component values. Specified bin resolution, automatic generation of bins C DynamicList A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects C Hash< DynamicList< T, SizeMin > > Hashing for List data C is_contiguous< FixedList< T, N > > FixedList is contiguous if the type is contiguous C is_contiguous_label< FixedList< T, N > > Check for FixedList of labels C is_contiguous_scalar< FixedList< T, N > > Check for FixedList of scalars C Hash< FixedList< T, N > > Hashing for FixedList data C Histogram Calculates the counts per bin of a list C Hash< List< T > > Hashing for List data C SubList A non-owning sub-view of a List (allocated or unallocated storage) C Hash< UList< T > > Hashing for List data C accessOp Object access operator or list access operator (default is pass-through) C emptyOp Test if object is empty, typically using its empty() method C sizeOp Extract size (as label) from an object, typically using its size() method C offsetOp Offset operator for ListListOps::combineOffset() C ParSortableList Implementation of PSRS parallel sorting routine C SortableList A list that is sorted upon construction or when explicitly requested with the sort() method C UniformList A single value that is represented as a list with an operator[] to access the value. This can be useful for templated operations expecting a list accessor C PtrDynList A dynamically resizable PtrList with allocation management C PtrList A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers. The operator[] returns a reference to the object, not the pointer C Callback Abstract class to handle automatic call-back registration with the CallbackRegistry . Derive from this class and extend by adding the appropriate callback functions C CallbackRegistry Base class with which callbacks are registered C adddictionaryToDebug C dictionary A list of keyword definitions, which are a keyword followed by a number of values (eg, words and numbers) or by a sub-dictionary. Since the dictionary format is used extensively throughout OpenFOAM for input/output files, there are many examples of its use C Searcher Generic const/non-const dictionary entry searcher C dictionaryContent A wrapper for dictionary content, without operators that could affect inheritance patterns C dictionaryEntry A keyword and a list of tokens is a 'dictionaryEntry ' C dictionaryListEntry Read/write List of dictionaries C entry A keyword and a list of tokens is an 'entry' C formattingEntry A dictionary entry writing only contents by default, used to save formatting symbols for the final output C functionEntry A functionEntry causes entries to be added/manipulated on the specified dictionary given an input stream C namedDictionary A tuple of keyType and dictionary, which can be used when reading named or unnamed dictionary entries or simply a name C primitiveEntry A keyword and a list of tokens comprise a primitiveEntry . A primitiveEntry can be read, written and printed, and the types and values of its tokens analysed C codedBase Base class for function objects and boundary conditions using dynamic code that provides methods for managing loading/unloading/updating of a dynamic library. For these purposes, it uses a dynamicCodeContext object to maintain information about the state C dlLibraryTable A table of dynamically loaded libraries C dynamicCode Tools for handling dynamic code compilation C dynamicCodeContext Encapsulation of dynamic code dictionaries C Enum Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values. All dictionary searches use a literal (not regex) C const_iterator A const_iterator for iterating an Enum list C error Class to handle errors and exceptions in a simple, consistent stream-based manner C IOerror Report an I/O error C errorManip Error stream manipulators for exit and abort which may terminate the program or throw an exception depending if the exception handling has been switched on (off by default) C errorManipArg Error stream manipulators for functions with an argument C messageStream Handle output messages in a simple, consistent stream-based manner C functionObject Abstract base-class for Time/database function objects C unavailableFunctionObject Abstract functionObject to report when a real version is unavailable C functionObjectList List of function objects with start() , execute() and end() functions that is called for each object C timeControl General time dependent execution controller. The execution parameters are given by the "Control" and (optionally) the "Interval", with the default being to execute every time-step C is_globalIOobject Trait for specifying global vs. local IOobject file types C is_coherentIOobject Trait for specifying IOobject types that support the coherent format C IOobject Defines the attributes of an object for which implicit objectRegistry management is supported, and provides the infrastructure for performing stream I/O C IOobjectList List of IOobjects with searching and retrieving facilities. Implemented as a HashTable , so the various sorted methods should be used if traversing in parallel C CompactIOField A Field of objects of type <T> with automated input and output using a compact storage. Behaves like IOField except when binary output in case it writes a CompactListList C CompactIOList A List of objects of type <T> with automated input and output using a compact storage. Behaves like IOList except when binary output in case it writes a CompactListList C decomposedBlockData The decomposedBlockData comprise a List <char> C GlobalIOField IOField with global data (so optionally read from master) C GlobalIOList IOList with global data (so optionally read from master) C is_globalIOobject< GlobalIOList< T > > Global file type for GlobalIOList C baseIOdictionary BaseIOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionality via the objectRegistry C IOdictionary IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionality via the objectRegistry . To facilitate IO, IOdictionary is provided with a constructor from IOobject and with readData/writeData functions C is_globalIOobject< IOdictionary > Global file type for IOdictionary C localIOdictionary LocalIOdictionary is derived from IOdictionary but excludes parallel master reading C unwatchedIOdictionary UnwatchedIOdictionary is like IOdictionary but stores dependencies as files instead of fileMonitor watchIndices. Used to read controlDict since there fileMonitor not yet setup C is_globalIOobject< unwatchedIOdictionary > Global file type for unwatchedIOdictionary C IOFieldRef A IOField wrapper for writing external data C IOList A List of objects of type <T> with automated input and output C IOListRef A IOList wrapper for writing external List data C IOMap A Map of objects of type <T> with automated input and output. Is a global object; i.e. can be read from undecomposed case C is_globalIOobject< IOMap< T > > Global file type for IOMap C IOPtrList A PtrList of objects of type <T> with automated input and output C rawIOField Like IOField but falls back to raw IFstream if no header found. Optionally reads average value. For use in MappedFile container C dummyISstream Dummy input stream, which can be used as a placeholder for interfaces taking an Istream or ISstream . Aborts at any attempt to read from it C ifstreamPointer A wrapped std::ifstream with possible compression handling (igzstream) that behaves much like a std::unique_ptr C ofstreamPointer A wrapped std::ofstream with possible compression handling (ogzstream) that behaves much like a std::unique_ptr C IFstream Input from file stream as an ISstream , normally using std::ifstream for the actual input C masterOFstream Master-only drop-in replacement for OFstream C OFstream Output to file stream as an OSstream , normally using std::ofstream for the actual output C base64Layer An output filter layer to write base-64 encoded content C osha1stream A basic output stream for calculating SHA1 digests C OSHA1stream The output stream for calculating SHA1 digests C INew A helper class when constructing from an Istream or dictionary C Smanip An IOstream manipulator taking arguments C Imanip An Istream manipulator taking arguments C Omanip An Ostream manipulator taking arguments C IOstream An IOstream is an abstract base class for all input/output systems; be they streams, files, token lists etc C Istream An Istream is an abstract base class for all input systems (streams, files, token lists etc). The basic operations are construct, close, read token, read primitive and read binary block C Ostream An Ostream is an abstract base class for all output systems (streams, files, token lists, etc) C icharstream Similar to std::istringstream, but with the ability to swap character content. Has some similarity to std::ispanstream (C++23) C ICharStream An ISstream with internal List storage. Always UNCOMPRESSED C ispanstream Similar to std::istringstream, but with an externally managed input buffer which makes it most similar to std::ispanstream (C++23) C ISpanStream Similar to IStringStream but using an externally managed buffer for its input. This allows the input buffer to be filled (and refilled) from various sources C memorybuf A streambuf for memory similar to std::spanbuf (C++23) C in_base The base input streambuf with memory access C in_dynamic An output streambuf for memory access C out_base An output streambuf for memory access C out_dynamic An output streambuf for memory access C ocharstream Similar to std::ostringstream, but with the ability to swap character content. Has some similarity to std::ospanstream (C++23) C OCharStream An OSstream with internal List storage C ocountstream Trivial output stream for calculating byte counts C OCountStream An output stream for calculating byte counts C ospanstream Similar to std::ostringstream, but with an externally managed output buffer which makes it most similar to std::ospanstream (C++23) C OSpanStream Similar to OCharStream but using an externally managed buffer for its output C IStringStream Input from string buffer, using a ISstream . Always UNCOMPRESSED C OStringStream Output to string buffer, using a OSstream . Always UNCOMPRESSED C IPstream Input inter-processor communications stream C IPBstream Input inter-processor communications stream using MPI broadcast C OPstream Output inter-processor communications stream C OPBstream Output inter-processor communications stream using MPI broadcast C Pstream Inter-processor communications stream C PstreamBuffers Buffers for inter-processor communications streams (UOPstream , UIPstream ) C UIPstreamBase Base class for input inter-processor communications stream (ie, parallel streams). Not to be used directly, thus contructors are protected C UIPstream Input inter-processor communications stream using MPI send/recv etc. - operating on external buffer C UIPBstream Input inter-processor communications stream using MPI broadcast - operating on external buffer C UOPstreamBase Base class for output inter-processor communications stream (ie, parallel streams). Not to be used directly, thus contructors are protected C UOPstream Output inter-processor communications stream using MPI send/recv etc. - operating on external buffer C UOPBstream Output inter-processor communications stream using MPI broadcast - operating on external buffer C UPstream Inter-processor communications stream C commsStruct Structure for communicating between processors C commsStructList Collection of communication structures C communicator Wrapper for internally indexed communicator label. Always invokes UPstream::allocateCommunicatorComponents() and UPstream::freeCommunicatorComponents() C Communicator An opaque wrapper for MPI_Comm with a vendor-independent representation without any <mpi.h> header C Request An opaque wrapper for MPI_Request with a vendor-independent representation without any <mpi.h> header C File An opaque wrapper for MPI_File methods without any <mpi.h> header dependency C Impl C Window An opaque wrapper for MPI_Win with a vendor-independent representation and without any <mpi.h> header dependency C UPstream_mpi_dataType UPstream data type corresponding to a fundamental (MPI) type C UPstream_mpi_dataType< void > Disallow void C UPstream_user_dataType UPstream data type corresponding to user-defined type C UPstream_user_dataType< void > Disallow void C UPstream_mpi_dataType< char > Map char to UPstream::dataTypes::type_byte C UPstream_mpi_dataType< const char > Map const char to UPstream::dataTypes::type_byte C UPstream_mpi_dataType< unsigned char > Map unsigned char to UPstream::dataTypes::type_byte C UPstream_mpi_dataType< const unsigned char > Map const unsigned char to UPstream::dataTypes::type_byte C UPstream_mpi_dataType< int16_t > Map int16_t to UPstream::dataTypes::type_int16 C UPstream_mpi_dataType< const int16_t > Map const int16_t to UPstream::dataTypes::type_int16 C UPstream_mpi_dataType< int32_t > Map int32_t to UPstream::dataTypes::type_int32 C UPstream_mpi_dataType< const int32_t > Map const int32_t to UPstream::dataTypes::type_int32 C UPstream_mpi_dataType< int64_t > Map int64_t to UPstream::dataTypes::type_int64 C UPstream_mpi_dataType< const int64_t > Map const int64_t to UPstream::dataTypes::type_int64 C UPstream_mpi_dataType< uint16_t > Map uint16_t to UPstream::dataTypes::type_uint16 C UPstream_mpi_dataType< const uint16_t > Map const uint16_t to UPstream::dataTypes::type_uint16 C UPstream_mpi_dataType< uint32_t > Map uint32_t to UPstream::dataTypes::type_uint32 C UPstream_mpi_dataType< const uint32_t > Map const uint32_t to UPstream::dataTypes::type_uint32 C UPstream_mpi_dataType< uint64_t > Map uint64_t to UPstream::dataTypes::type_uint64 C UPstream_mpi_dataType< const uint64_t > Map const uint64_t to UPstream::dataTypes::type_uint64 C UPstream_mpi_dataType< float > Map float to UPstream::dataTypes::type_float C UPstream_mpi_dataType< const float > Map const float to UPstream::dataTypes::type_float C UPstream_mpi_dataType< double > Map double to UPstream::dataTypes::type_double C UPstream_mpi_dataType< const double > Map const double to UPstream::dataTypes::type_double C UPstream_mpi_dataType< long double > Map long double to UPstream::dataTypes::type_long_double C UPstream_mpi_dataType< const long double > Map const long double to UPstream::dataTypes::type_long_double C UPstream_user_dataType< Vector< float > > Map Vector<float> UPstream::dataTypes::type_3float C UPstream_user_dataType< const Vector< float > > Map const Vector<float> UPstream::dataTypes::type_3float C UPstream_user_dataType< Vector< double > > Map Vector<double> UPstream::dataTypes::type_3double C UPstream_user_dataType< const Vector< double > > Map const Vector<double> UPstream::dataTypes::type_3double C UPstream_user_dataType< SymmTensor< float > > Map SymmTensor<float> UPstream::dataTypes::type_6float C UPstream_user_dataType< const SymmTensor< float > > Map const SymmTensor<float> UPstream::dataTypes::type_6float C UPstream_user_dataType< SymmTensor< double > > Map SymmTensor<double> UPstream::dataTypes::type_6double C UPstream_user_dataType< const SymmTensor< double > > Map const SymmTensor<double> UPstream::dataTypes::type_6double C UPstream_user_dataType< Tensor< float > > Map Tensor<float> UPstream::dataTypes::type_9float C UPstream_user_dataType< const Tensor< float > > Map const Tensor<float> UPstream::dataTypes::type_9float C UPstream_user_dataType< Tensor< double > > Map Tensor<double> UPstream::dataTypes::type_9double C UPstream_user_dataType< const Tensor< double > > Map const Tensor<double> UPstream::dataTypes::type_9double C UPstream_alias_dataType Explicit handling of data type aliases. This is necessary since different systems map things like 'unsigned long' differently but we restrict ourselves to int32/int64 types C UPstream_alias_dataType< int8_t > Map int8_t to UPstream::dataTypes::type_byte C UPstream_alias_dataType< uint8_t > Map uint8_t to UPstream::dataTypes::type_byte C UPstream_any_dataType UPstream data type (fundamental or user-defined), after resolving any aliases C UPstream_basic_dataType UPstream fundamental/aliased (excludes user-defined) data type or a component aggregate of the same C UPstream_basic_dataType< void > Disallow void C UPstream_dataType UPstream fundamental/aliased/user-defined data type or a component aggregate of the same C UPstream_dataType< void > Disallow void C UPstream_opType A supported UPstream (MPI) reduce/window operation type C UPstream_opType< void > Disallow void C UPstream_opType< Foam::minOp< T > > Map minOp <T> to UPstream::opCodes::op_min C UPstream_opType< Foam::maxOp< T > > Map maxOp <T> to UPstream::opCodes::op_max C UPstream_opType< Foam::sumOp< T > > Map sumOp <T> to UPstream::opCodes::op_sum C UPstream_opType< Foam::plusOp< T > > Map plusOp <T> (same as sumOp <T>) to UPstream::opCodes::op_sum C UPstream_opType< Foam::multiplyOp< T > > Map multiplyOp <T> to UPstream::opCodes::op_prod C UPstream_opType< Foam::bitAndOp< T > > Map bitAndOp <T> to UPstream::opCodes::op_bit_and C UPstream_opType< Foam::bitOrOp< T > > Map bitOrOp <T> to UPstream::opCodes::op_bit_or C UPstream_opType< Foam::bitXorOp< T > > Map bitXorOp <T> to UPstream::opCodes::op_bit_xor C UPstream_data_opType Combined query of opType and the underlying basic data type C ISstream Generic input stream using a standard (STL) stream C OSstream Generic output stream using a standard (STL) stream C prefixOSstream Version of OSstream that prints a prefix on each line C token A token holds an item read from Istream C compound Abstract base class for complex tokens C Compound A templated class for holding compound tokens. The underlying container is normally a List of values, it must have a value_type size() , resize() , cdata_bytes() , data_bytes() , size_bytes() methods C ITstream An input stream of tokens C OTstream A simple output token stream that can be used to build token lists. Always UNCOMPRESSED C objectRegistry Registry of regIOobjects C IOobjectOption A simple container of IOobject preferences. Can also be used for general handling of read/no-read/read-if-present logic outside of an IOobject C IOstreamOption A simple container for options an IOstream can normally have C versionNumber Representation of a major/minor version number C regIOobject RegIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry C Instant A tuple of scalar value and key. The value often corresponds to a time value, thus the naming of the class. The key will usually be a time name or a file name etc C less Less function for sorting. Compares values only C Pair An ordered pair of two objects of type <T> with first() and second() elements C symmHasher Symmetric hashing functor for Pair , hashes lower value first C instant An instant of time. Contains the time value and name. Uses Foam::Time when formatting the name C subCycleTime A class for managing sub-cycling times C subLoopTime A class for managing sub-loops referencing Time C Time Class to control time during OpenFOAM simulations that is also the top-level objectRegistry C TimePaths Address the time paths without using the Time class C timeSelector The timeSelector provides a convenient means of selecting multiple times C TimeState The time value with time-stepping information, user-defined remapping, etc C isAOp Test if dynamic_cast to Type is possible, as a functor C isTypeOp Test if typeid is identical to the Type, as a functor C dimensioned Generic dimensioned Type class C dimensionSet Dimension set for the base types, which can be used to implement rigorous dimension checking for algebraic manipulation C dimensionSets Construction of unit sets C Hash< expressions::exprString > Hashing for exprString is the same as string C exprTypeTraits Simple type identifiers for polymorphic expression values. The definitions are similar to std::integral_constant in that they provide value, value_type (and name) C exprTypeTraits< bool > bool expression traits C exprTypeTraits<::Foam::label > label expression traits C exprTypeTraits<::Foam::scalar > scalar expression traits C exprTypeTraits<::Foam::vector > vector expression traits C exprTypeTraits<::Foam::tensor > tensor expression traits C exprTypeTraits<::Foam::sphericalTensor > sphericalTensor C exprTypeTraits<::Foam::symmTensor > symmTensor C nameOp< expressions::valueTypeCode > A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID C is_contiguous< expressions::exprValue > The data content are contiguous C cloud A cloud is a registry collection of lagrangian particles C reuseTmpDimensionedField C reuseTmpDimensionedField< TypeR, TypeR, GeoMesh > C reuseTmpTmpDimensionedField C reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh > C reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh > C reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh > C SlicedDimensionedField Specialisation of DimensionedField that holds a slice of a given field so that it acts as a DimensionedField C FieldField A field of fields is a PtrList of fields with reference counting C reuseTmpFieldField C reuseTmpFieldField< Field, TypeR, TypeR > C reuseTmpTmpFieldField C reuseTmpTmpFieldField< Field, TypeR, Type1, Type12, TypeR > C reuseTmpTmpFieldField< Field, TypeR, TypeR, TypeR, Type2 > C reuseTmpTmpFieldField< Field, TypeR, TypeR, TypeR, TypeR > C oneFieldField A class representing the concept of a field of oneFields used to avoid unnecessary manipulations for objects which are known to be one at compile-time C zeroFieldField A class representing the concept of a field of zeroFields used to avoid unnecessary manipulations for objects which are known to be zero at compile-time C DynamicField Dynamically sized Field . Similar to DynamicList , but inheriting from a Field instead of a List C DirectFieldMapper A templated direct mapper for the given FieldMapper type C DistributedFieldMapper A templated field mapper with direct mapping from local or remote quantities C Field Generic templated field type that is much like a Foam::List except that it is expected to hold numerical content (not generic elements such as strings etc) C SubField SubField is a Field obtained as a section of another Field , without its own allocation. SubField is derived from a SubList rather than a List C FieldBase Template invariant parts for Field and SubField C FieldMapper Abstract base class to hold the Field mapping addressing and weights C reuseTmp C reuseTmp< TypeR, TypeR > C reuseTmpTmp C reuseTmpTmp< TypeR, Type1, Type12, TypeR > C reuseTmpTmp< TypeR, TypeR, TypeR, Type2 > C reuseTmpTmp< TypeR, TypeR, TypeR, TypeR > C oneField A class representing the concept of a field of 1 used to avoid unnecessary manipulations for objects which are known to be one at compile-time C UniformField A class representing the concept of a uniform field which stores only the single value and providing the operator[] to return it C zeroField A class representing the concept of a field of 0 used to avoid unnecessary manipulations for objects which are known to be zero at compile-time C GeometricBoundaryField Generic GeometricBoundaryField class C reuseTmpGeometricField C reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh > C reuseTmpTmpGeometricField C reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh > C reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh > C reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh > C MapInternalField Generic internal field mapper. For "real" mapping, add template specialisations for mapping of internal fields depending on mesh type C geometricOneField A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for objects which are known to be one at compile-time C geometricZeroField A class representing the concept of a GeometricField of 0 used to avoid unnecessary manipulations for objects which are known to be zero at compile-time C basicSymmetryPointPatchField A Symmetry boundary condition for pointField C calculatedPointPatchField A calculated boundary condition for pointField C coupledPointPatchField A Coupled boundary condition for pointField C fixedValuePointPatchField A FixedValue boundary condition for pointField C valuePointPatchField Foam::valuePointPatchField C zeroGradientPointPatchField Foam::zeroGradientPointPatchField C zeroValuePointPatchField Specifies a zero fixed value boundary condition C cyclicPointPatchField Cyclic front and back plane patch field C cyclicSlipPointPatchField Cyclic + slip constraints C emptyPointPatchField An empty boundary condition for pointField C nonuniformTransformCyclicPointPatchField Cyclic + slip constraints C processorPointPatchField Foam::processorPointPatchField C processorCyclicPointPatchField Foam::processorCyclicPointPatchField C symmetryPointPatchField A Symmetry boundary condition for pointField C symmetryPlanePointPatchField A symmetry-plane boundary condition for pointField C wedgePointPatchField Wedge front and back plane patch field C codedFixedValuePointPatchField Constructs on-the-fly a new boundary condition (derived from fixedValuePointPatchField ) which is then used to evaluate C fixedNormalSlipPointPatchField Slip with user-specified normal C slipPointPatchField Foam::slipPointPatchField C timeVaryingUniformFixedValuePointPatchField A time-varying form of a uniform fixed value boundary condition C pointConstraint Accumulates point constraints through successive applications of the applyConstraint function C pTraits< pointConstraint > Template specialisation for pTraits <pointConstraint > to enable IO C is_contiguous< pointConstraint > Contiguous data for pointConstraint C combineConstraintsEqOp Reduce operator C pointPatchFieldBase Template invariant parts for pointPatchField C pointPatchFieldMapper Foam::pointPatchFieldMapper C pointPatchFieldMapperPatchRef Foam::pointPatchFieldMapperPatchRef C UniformDimensionedField Dimensioned<Type> registered with the database as a registered IOobject which has the functionality of a uniform field and allows values from the top-level code to be passed to boundary conditions etc C is_globalIOobject< UniformDimensionedField< Type > > Global file type for UniformDimensionedField C argList Extract command arguments and options from the supplied argc and argv parameters C ParRunControl Helper class for initializing parallel jobs from the command arguments, storing 'dry-run' state etc. Also handles cleanup of parallel (or serial) jobs C clock Read access to the system clock with formatting C clockTime Starts timing and returns elapsed time from start. Uses std::chrono::high_resolution_clock for better resolution (2uSec instead of ~20mSec) than cpuTime C clockValue Access to high-resolution clock value with some basic operations. Used to calculate time durations, elapsed times etc C cpuTimeCxx Starts timing CPU usage and return elapsed time from start C RegisterDebugSwitch Define the debug information, lookup as name C RegisterSwitch Class and registration macros for InfoSwitches and OptimisationSwitches to support reading from system/controlDict and dynamic update C simpleObjectRegistryEntry C simpleObjectRegistry Object registry for simpleRegIOobject . Maintains ordering C simpleRegIOobject Abstract base class for registered object with I/O. Used in debug symbol registration C OFstreamCollator Threaded file writer C threadedCollatedOFstream Master-only drop-in replacement for OFstream C fileOperation An encapsulation of filesystem-related operations C JobInfo Helper class for recording information about run/finished jobs, acts like global singleton C profiling Code profiling C profilingInformation Code profiling information in terms of time spent, number of calls etc C profilingPstream Timers and values for simple (simplistic) mpi-profiling. The entire class behaves as a singleton C profilingSysInfo General system information useful for profiling C profilingTrigger Triggers for starting/stopping code profiling C identityOp A functor that returns its argument unchanged (cf. C++20 std::identity) Should never be specialized C interpolation2DTable 2D table interpolation. The data must be in ascending order in both dimensions x and y C interpolationLookUpTable A list of lists. Interpolates based on the first dimension. The values must be positive and monotonically increasing in each dimension C interpolationTable An interpolation/look-up table of scalar vs <Type> values. The reference scalar values must be monotonically increasing C csvTableReader Reads an interpolation table from a file - CSV-format C openFoamTableReader Reads an interpolation table from a file - OpenFOAM-format C tableReader Base class to read table data for the interpolationTable C interpolationWeights Abstract base class for interpolating in 1D C linearInterpolationWeights C splineInterpolationWeights Catmull-Rom spline interpolation C PatchToPatchInterpolationBase C PatchToPatchInterpolation Interpolation class dealing with transfer of data between two primitivePatches C PrimitivePatchInterpolation Interpolation class within a primitive patch. Allows interpolation from points to faces and vice versa C uniformInterpolationTable Table with uniform interval in independent variable, with linear interpolation C Matrix A templated (m x n) matrix of objects of <T>. The layout is (mRows x nCols) - row-major order: C DiagonalMatrix A templated (N x N) diagonal matrix of objects of <Type>, effectively containing N elements, derived from List C EigenMatrix EigenMatrix (i.e. eigendecomposition or spectral decomposition) decomposes a diagonalisable nonsymmetric real square matrix into its canonical form, whereby the matrix is represented in terms of its eigenvalues and eigenvectors C lduAddressing The class contains the addressing required by the lduMatrix : upper, lower and losort C cyclicLduInterface An abstract base class for cyclic coupled interfaces C lduCalculatedProcessorField A lduProcessorField type bypassing coupledFvPatchField C lduInterface An abstract base class for implicitly-coupled interfaces e.g. processor and cyclic patches C lduPrimitiveProcessorInterface Concrete implementation of processor interface. Used to temporarily store settings C processorLduInterface An abstract base class for processor coupled interfaces C cyclicLduInterfaceField Abstract base class for cyclic coupled interfaces C lduInterfaceField An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields C processorLduInterfaceField Abstract base class for processor coupled interfaces C lduScheduleEntry Struct to hold the patch index and the initialisation flag for the patch schedule C LduInterfaceField An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields C LduMatrix LduMatrix is a general matrix class in which the coefficients are stored as three arrays, one for the upper triangle, one for the lower triangle and a third for the diagonal C solver Abstract base-class for LduMatrix solvers C smoother Abstract base-class for LduMatrix smoothers C preconditioner Abstract base-class for LduMatrix preconditioners C lduMatrix LduMatrix is a general matrix class in which the coefficients are stored as three arrays, one for the upper triangle, one for the lower triangle and a third for the diagonal C solver Abstract base-class for lduMatrix solvers C smoother Abstract base-class for lduMatrix smoothers C preconditioner Abstract base-class for lduMatrix preconditioners C SolverPerformance SolverPerformance is the class returned by the LduMatrix solver containing performance statistics C DiagonalPreconditioner Diagonal preconditioner for both symmetric and asymmetric matrices C diagonalPreconditioner Diagonal preconditioner for both symmetric and asymmetric matrices C DICPreconditioner Simplified diagonal-based incomplete Cholesky preconditioner for symmetric matrices (symmetric equivalent of DILU). The reciprocal of the preconditioned diagonal is calculated and stored C DILUPreconditioner Simplified diagonal-based incomplete LU preconditioner for asymmetric matrices. The reciprocal of the preconditioned diagonal is calculated and stored C TDILUPreconditioner Simplified diagonal-based incomplete LU preconditioner for asymmetric matrices C FDICPreconditioner Faster version of the DICPreconditioner diagonal-based incomplete Cholesky preconditioner for symmetric matrices (symmetric equivalent of DILU) in which the reciprocal of the preconditioned diagonal and the upper coefficients divided by the diagonal are calculated and stored C GAMGPreconditioner Geometric agglomerated algebraic multigrid preconditioner C NoPreconditioner Null preconditioner for both symmetric and asymmetric matrices C noPreconditioner Null preconditioner for both symmetric and asymmetric matrices C DICSmoother Simplified diagonal-based incomplete Cholesky smoother for symmetric matrices C DICGaussSeidelSmoother Combined DIC/GaussSeidel smoother for symmetric matrices in which DIC smoothing is followed by GaussSeidel to ensure that any "spikes" created by the DIC sweeps are smoothed-out C DILUSmoother Simplified diagonal-based incomplete LU smoother for asymmetric matrices C DILUGaussSeidelSmoother Combined DILU/GaussSeidel smoother for asymmetric matrices in which DILU smoothing is followed by GaussSeidel to ensure that any "spikes" created by the DILU sweeps are smoothed-out C FDICSmoother Simplified diagonal-based incomplete Cholesky smoother for symmetric matrices C GaussSeidelSmoother A lduMatrix::smoother for Gauss-Seidel C TGaussSeidelSmoother Foam::TGaussSeidelSmoother C nonBlockingGaussSeidelSmoother Variant of gaussSeidelSmoother that expects processor boundary cells to be sorted last and so can block later. Only when the cells are actually visited does it need the results to be present. It is expected that there is little benefit to be gained from doing this on a patch by patch basis since the number of processor interfaces is quite small and the overhead of checking whether a processor interface is finished might be quite high (call into mpi). Also this would require a dynamic memory allocation to store the state of the outstanding requests C symGaussSeidelSmoother A lduMatrix::smoother for symmetric Gauss-Seidel C DiagonalSolver Foam::DiagonalSolver C diagonalSolver Foam::diagonalSolver C FPCG A 'faster' preconditioned conjugate gradient solver for symmetric lduMatrices using a run-time selectable preconditioner C algebraicPairGAMGAgglomeration Agglomerate using the pair algorithm C dummyAgglomeration Agglomerate without combining cells. Used for testing C GAMGAgglomeration Geometric agglomerated algebraic multigrid agglomeration class C pairGAMGAgglomeration Agglomerate using the pair algorithm C eagerGAMGProcAgglomeration 'Eager' processor agglomeration of GAMGAgglomerations: at every level agglomerates 'mergeLevels' number of processors onto the minimum processor number C GAMGProcAgglomeration Processor agglomeration of GAMGAgglomerations C manualGAMGProcAgglomeration Manual processor agglomeration of GAMGAgglomerations C masterCoarsestGAMGProcAgglomeration Processor agglomeration of GAMGAgglomerations C noneGAMGProcAgglomeration Processor agglomeration of GAMGAgglomerations C procFacesGAMGProcAgglomeration Processor agglomeration of GAMGAgglomerations. Needs nAgglomeratingCells which is when to start agglomerating processors. Processors get agglomerated by constructing a single cell mesh for each processor with each processor interface a face. This then gets agglomerated using the pairGAMGAgglomeration algorithm with the number of faces on the original processor interface as face weight C GAMGSolver Geometric agglomerated algebraic multigrid solver C cyclicGAMGInterfaceField GAMG agglomerated cyclic interface field C GAMGInterfaceField Abstract base class for GAMG agglomerated interface fields C processorCyclicGAMGInterfaceField GAMG agglomerated processor interface field C processorGAMGInterfaceField GAMG agglomerated processor interface field C cyclicGAMGInterface GAMG agglomerated cyclic interface C GAMGInterface Abstract base class for GAMG agglomerated interfaces C processorCyclicGAMGInterface GAMG agglomerated processor interface C processorGAMGInterface GAMG agglomerated processor interface C PBiCCCG Preconditioned bi-conjugate gradient solver for asymmetric lduMatrices using a run-time selectable preconditioner C PBiCG Preconditioned bi-conjugate gradient solver for asymmetric lduMatrices using a run-time selectable preconditioner C PBiCGStab Preconditioned bi-conjugate gradient stabilized solver for asymmetric lduMatrices using a run-time selectable preconditioner C PBiCICG Preconditioned bi-conjugate gradient solver for asymmetric lduMatrices using a run-time selectable preconditioner C PCG Preconditioned conjugate gradient solver for symmetric lduMatrices using a run-time selectable preconditioner C PCICG Preconditioned conjugate gradient solver for symmetric lduMatrices using a run-time selectable preconditioner C PPCG Preconditioned pipelined conjugate gradient solver for symmetric lduMatrices using a run-time selectable preconditioner C PPCR Preconditioned pipelined conjugate residuals solver for symmetric lduMatrices using a run-time selectable preconditioner C SmoothSolver Iterative solver for symmetric and asymmetric matrices which uses a run-time selected smoother e.g. GaussSeidel to converge the solution to the required tolerance. To improve efficiency, the residual is evaluated after every nSweeps smoothing iterations C smoothSolver Iterative solver for symmetric and asymmetric matrices which uses a run-time selected smoother e.g. GaussSeidel to converge the solution to the required tolerance C LLTMatrix Templated class to perform the Cholesky decomposition on a symmetric positive-definite matrix C LUscalarMatrix Class to perform the LU decomposition on a symmetric matrix C procLduInterface IO interface for processorLduInterface C procLduMatrix I/O for lduMatrix and interface values C ConstMatrixBlock C MatrixBlock A templated block of an (m x n) matrix of type <MatrixType> C QRMatrix QRMatrix A into the following: C RectangularMatrix A templated (M x N) rectangular matrix of objects of <Type>, containing M*N elements, derived from Matrix C typeOfInnerProduct< Type, RectangularMatrix< Type >, RectangularMatrix< Type > > C typeOfInnerProduct< Type, RectangularMatrix< Type >, SquareMatrix< Type > > C typeOfInnerProduct< Type, SquareMatrix< Type >, RectangularMatrix< Type > > C Tensor A templated (3 x 3) tensor of objects of <T> derived from MatrixSpace C SVD Singular value decomposition of a rectangular matrix C schemesLookup Selector class for finite area/finite volume differencing schemes C is_globalIOobject< schemesLookup > Global file type for schemesLookup - same content for all ranks C simpleMatrix A simple square matrix solver with scalar coefficients C solution Selector class for relaxation factors, solver type and solution C typeOfInnerProduct< Type, SquareMatrix< Type >, SquareMatrix< Type > > C SquareMatrix A templated (N x N) square matrix of objects of <Type>, containing N*N elements, derived from Matrix C SymmetricSquareMatrix A templated (N x N) square matrix of objects of <Type>, containing N*N elements, derived from Matrix C tolerances Selector class for solution tolerances C MemoryPool Optional memory management using a memory pool such as Umpire (https://github.com/LLNL/Umpire ) C ConstPrecisionAdaptor A const Field/List wrapper with possible data conversion C PrecisionAdaptor A non-const Field/List wrapper with possible data conversion C refCount Reference counter for various OpenFOAM components C zero A non-counting (dummy) refCount C boundBox A bounding box defined in terms of min/max extrema points C is_contiguous< boundBox > Contiguous data for boundBox C is_contiguous_scalar< boundBox > Contiguous scalar data for boundBox C GeoMesh Generic mesh wrapper used by volMesh , surfaceMesh , pointMesh etc C DynamicID A class that holds the data needed to identify things (zones, patches) in a dynamic mesh C coupleGroupIdentifier Encapsulates using "patchGroups" to specify coupled patch C patchIdentifier Identifies a patch by name and index, with optional physical type and group information C geometricSurfacePatch Identifies a surface patch/zone by name and index, with geometric type C fromIdentifier Helper to convert identifier types as an operation C surfZoneIdentifier Identifies a surface patch/zone by name and index, with optional geometric type C zoneIdentifier Identifies a mesh zone by name and index, with optional physical type and group information C ijkAddressing A simple i-j-k (row-major order) to linear addressing C IjkField Generic templated field type with i-j-k addressing C ijkMesh A simple i-j-k (row-major order) to linear addressing for a rectilinear mesh. Since the underlying mesh is rectilinear, some mesh-related sizing information can be derived directly from the addressing information C lduMesh Abstract base class for meshes which provide LDU addressing for the construction of lduMatrix and LDU-solvers C lduPrimitiveMesh Simplest concrete lduMesh that stores the addressing needed by lduMatrix C meshObject The meshObject is a concrete regIOobject to register MeshObject items C MeshObject Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh database and the mesh-modifier event-loop C TopologicalMeshObject C GeometricMeshObject C MoveableMeshObject C UpdateableMeshObject C cell A cell is defined as a list of faces with extra functionality C cellMatcher Base class for cellshape matchers (hexMatch, prismMatch, etc.). These are classes which given a mesh and cell number find out the orientation of the cellShape and construct cell-vertex to mesh-vertex mapping and cell-face to mesh-face mapping C degenerateMatcher Collection of all hex degenerate matchers (hex, wedge, prism etc.) C hexMatcher A cellMatcher for hex cells (cellModel::HEX ) C prismMatcher A cellMatcher for prism cells (cellModel::PRISM ) C pyrMatcher A cellMatcher for pyr cells (cellModel::PYR ) C tetMatcher A cellMatcher for tet cells (cellModel::TET ) C tetWedgeMatcher A cellMatcher for tetWedge cells (cellModel::TETWEDGE ) C wedgeMatcher A cellMatcher for wedge cells (cellModel::WEDGE ) C cellModel Maps a geometry to a set of cell primitives C cellModeller C cellShape An analytical geometric cellShape C edge An edge is a list of two vertex labels. This can correspond to a directed graph edge or an edge on a mesh C hasher Hashing functor for edge (commutative) C Hash Deprecated(2021-04) hashing functor. Use hasher() C is_contiguous< edge > Contiguous data for edge (a pair of labels) C is_contiguous_label< edge > Contiguous label data for edge (a pair of labels) C Hash< edge > Hashing for edge uses commutative (incremental) hash C EdgeMap Map from edge (expressed as its endpoints) to value. Hashing (and ==) on an edge is symmetric C face A face is a list of labels corresponding to mesh vertices C hasher Hashing functor for face C symmHasher Symmetric hashing functor for face C Hash< face > Hash face as contiguous (non-commutative) list data C offsetOp< face > Specialization to offset faces, used in ListListOps::combineOffset C oppositeFace Class containing opposite face for a prismatic cell with addressing and a possibility of failure C hexCell A hexahedral cell primitive C is_contiguous< hexCell > Contiguous data for hexCell C is_contiguous_label< hexCell > Contiguous label data for hexCell C labelledTri A triFace with additional (region) index C is_contiguous< labelledTri > Contiguous data for labelledTri C is_contiguous_label< labelledTri > Contiguous label data for labelledTri C offsetOp< labelledTri > Specialization to offset faces, used in ListListOps::combineOffset C tetCell A tetrahedral cell primitive C is_contiguous< tetCell > Contiguous data for tetCell C is_contiguous_label< tetCell > Contiguous label data for tetCell C faceTraits Traits class for faces C triFace A triangular face using a FixedList of labels corresponding to mesh vertices C hasher Hashing functor for triFace (commutative) C Hash Deprecated(2021-04) hashing functor. Use hasher() C is_contiguous< triFace > Contiguous data for triFace C is_contiguous_label< triFace > Contiguous label data for triFace C Hash< triFace > Hashing for triFace uses commutative (incremental) hash C offsetOp< triFace > Specialization to offset faces, used in ListListOps::combineOffset C meshState Database for mesh data, solution data, solver performance and other reduced data C pointBoundaryMesh A pointBoundaryMesh is a pointPatch list with registered IO, a reference to the associated pointMesh , with additional search methods etc C pointMesh Mesh representing a set of points created from polyMesh C MapInternalField< Type, MeshMapper, pointMesh > C pointBoundaryMeshMapper Foam::pointBoundaryMeshMapper C pointMapper This object provides mapping and fill-in information for point data between the two meshes after the topological change. It is constructed from mapPolyMesh C pointMeshMapper Class holds all the necessary information for mapping fields associated with pointMesh C pointPatchMapper Mapping class for a pointPatchField C pointMeshTools C coupledPointPatch Coupled patch for post-processing. Used as the base class for processor and cyclic pointPatches C genericPointPatch Substitute for unknown patches. Used for postprocessing when only basic polyPatch info is needed C cyclicPointPatch Cyclic patch for post-processing C cyclicSlipPointPatch Cyclic patch with slip constraint C emptyPointPatch Empty plane patch C nonuniformTransformCyclicPointPatch Cyclic patch with slip constraint C processorPointPatch Processor patch boundary needs to be such that the ordering of points in the patch is the same on both sides C processorCyclicPointPatch Processor patch boundary needs to be such that the ordering of points in the patch is the same on both sides C symmetryPointPatch Symmetry patch for non-planar or multi-plane patches C symmetryPlanePointPatch Symmetry-plane patch C wedgePointPatch Wedge front and back plane patch C coupledFacePointPatch Coupled patch for post-processing. Used as the base class for processor and cyclic pointPatches C wallPointPatch Foam::wallPointPatch C facePointPatch A pointPatch based on a polyPatch C meshPointPatch PointPatch with explicitly provided points instead of using the points of a polyPatch C pointPatch Basic pointPatch represents a set of points from the mesh C globalMeshData Various mesh related information for a parallel run. Upon construction, constructs all info using parallel communication C globalPoints Calculates points shared by more than two processor patches or cyclic patches C cellMapper This object provides mapping and fill-in information for cell data between the two meshes after the topological change. It is constructed from mapPolyMesh C faceMapper This object provides mapping and fill-in information for face data between the two meshes after the topological change. It is constructed from mapPolyMesh C mapAddedPolyMesh Class containing mesh-to-mesh mapping information after a mesh addition where we add a mesh ('added mesh') to an old mesh, creating a new mesh C IOmapDistribute IOmapDistribute is derived from mapDistribute and IOobject to give the mapDistribute automatic IO functionality via the objectRegistry C IOmapDistributePolyMesh IOmapDistributePolyMesh is derived from mapDistributePolyMesh and IOobject to give the mapDistributePolyMesh automatic IO functionality via the objectRegistry C IOmapDistributePolyMeshRef A IOmapDistributePolyMesh wrapper for using referenced external data C mapDistribute Class containing processor-to-processor mapping information C transform Default transformation behaviour C transformPosition Default transformation behaviour for position C mapDistributeBase Class containing processor-to-processor mapping information C mapDistributeLagrangian Mesh-to-mesh mapping information for particles C mapDistributePolyMesh Class containing mesh-to-mesh mapping information after a mesh distribution where we send parts of meshes (using subsetting) to other processors and receive and reconstruct mesh C mapPatchChange Class containing mesh-to-mesh mapping information after a patch change operation C mapPolyMesh Class containing mesh-to-mesh mapping information after a change in polyMesh topology C mapSubsetMesh Class containing mesh-to-mesh mapping information after a subset operation C morphFieldMapper Abstract base class to hold the Field mapping for mesh morphs C objectMap An objectMap is a pair of labels defining the mapping of an object from another object, e.g. a cell mapped from a point C polyBoundaryMesh A polyBoundaryMesh is a polyPatch list with registered IO, a reference to the associated polyMesh , with additional search methods etc C polyBoundaryMeshEntries Read and store dictionary entries for boundary patches The object is *never* registered to avoid registry name clashes with polyBoundaryMesh , which may either already have been registered, or which should subsequently be registered C polyMesh Mesh consisting of general polyhedral cells C polyMeshTools Collection of static functions operating on pointMesh C polyMeshTetDecomposition Tools for performing the minimum decomposition of faces of the mesh into triangles so that the cells may be tet decomposed. Includes functions for finding variable face starting (base) points on each face to avoid the decomposition of cells into tets that have negative or zero volume C tetIndices Storage and named access for the indices of a tet which is part of the decomposition of a cell C is_contiguous< tetIndices > Contiguous data for tetIndices C is_contiguous_label< tetIndices > Contiguous label data for tetIndices C coupledPolyPatch The coupledPolyPatch is an abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links C genericPolyPatch Substitute for unknown patches. Used for postprocessing when only basic polyPatch info is needed or if the real patch type is unavailable C cyclicPolyPatch Cyclic plane patch C cyclicSlipPolyPatch Copy of cyclicSlip - used to be able to instantiate cyclicSlip pointPatch which is cyclicSlip with slip constraints C emptyPolyPatch Empty front and back plane patch. Used for 2-D geometries C nonuniformTransformCyclicPolyPatch Transform boundary used in extruded regions. Allows non-uniform transforms. Wip C oldCyclicPolyPatch 'old' style cyclic polyPatch with all faces in single patch. Does ordering but cannot be used to run. Writes 'type cyclic' so foamUpgradeCyclics can be run afterwards. Used to get cyclics from mesh converters that assume cyclics in single patch (e.g. fluent3DMeshToFoam) C processorPolyPatch Neighbour processor patch C processorCyclicPolyPatch Neighbour processor patch C symmetryPolyPatch Symmetry patch for non-planar or multi-plane patches C symmetryPlanePolyPatch Symmetry-plane patch C wedgePolyPatch Wedge front and back plane patch C wallPolyPatch Foam::wallPolyPatch C addpolyPatchToDebug C polyPatch A patch is a list of labels that address the faces in the global face list C labelRangeOp< polyPatch > The labelRange of a polyPatch C dummyTransform C pTraits< List< T > > C pTraits< UList< T > > C pTraits< Field< T > > C pTraits< face > C syncTools Various tools to aid synchronizing lists across coupled patches. WIP C cellZone A subset of mesh cells C faceZone A subset of mesh faces organised as a primitive patch C pointZone A subset of mesh points C zone Base class for mesh zones C PatchTools A collection of tools for searching, sorting PrimitivePatch information C primitiveMesh Cell-face mesh analysis engine C primitiveMeshTools Collection of static functions operating on primitiveMesh (mainly checks) C patchZones Calculates zone number for every face of patch C PrimitivePatch A list of faces which address into the list of points C PrimitivePatchBase Non-templated base elements for PrimitivePatch C addwalkPatchToDebug C walkPatch Collection of static functions to do various simple patch related things C line A line primitive C linePoints Line point storage. Default constructable (line is not) C objectHit This class describes a combination of target object index and success flag. Behaves somewhat like std::optional C PointHit Describes the interaction of a object and a (templated) point. It carries the info of a successful hit and (if successful) the interaction point C PointIndexHit This class describes the interaction of an object (often a face) and a point. It carries the info of a successful hit and (if successful), returns the interaction point C is_contiguous< pointIndexHit > Contiguous data for pointIndexHit C plane Geometric class that creates a 3D plane and can return the intersection point between a line and the plane C ray A reference point and direction C pyramid A geometric pyramid primitive with a base of 'n' sides: i.e. a parametric pyramid. A pyramid is constructed from a base polygon and an apex point C tetrahedron A tetrahedron primitive C dummyOp Dummy C sumVolOp Sum resulting volumes C storeOp Store resulting tets C tetPoints Tet point storage. Default constructable (tetrahedron is not) C intersection Foam::intersection C triPoints Triangle point storage. Default constructable (triangle is not) C triangle A triangle primitive used to calculate face normals and swept volumes. Uses referred points C dummyOp Dummy C sumAreaOp Sum resulting areas C storeOp Store resulting tris C volumeType An enumeration wrapper for classification of a location as being inside/outside of a volume C is_contiguous< volumeType > Contiguous data for volumeType C treeBoundBox Standard boundBox with extra functionality for use in octree C is_contiguous< treeBoundBox > Contiguous data for treeBoundBox C is_contiguous_scalar< treeBoundBox > Contiguous scalar data for treeBoundBox C orientedType Class to determine the 'oriented' status of surface fields C commSchedule Determines the order in which a set of processors should communicate with one another C fieldsDistributor C globalIndex Calculates a non-overlapping list of offsets based on an input size (eg, number of cells) from different MPI ranks. These offsets can be used to define a unique (global) indexing number C gatherNone Dispatch tag: Construct with a single (local size) entry, no communication C gatherOnly Dispatch tag: Construct 'one-sided' from local sizes, using gather but no broadcast C gatherNonLocal Dispatch tag: Construct 'one-sided' from the non-master local sizes using gather but no broadcast C const_iterator Forward input iterator with const access that is used to iterate across the globalIndex offsets() table C GlobalOffset A Foam::OffsetRange (start, size, total) tuple with some additional parallel functionality. A common use case for OffsetRange would be the definition of non-overlapping global addressing C processorTopology Determines/represents processor-processor connection. After instantiation contains the processor-processor connection table (globally synchronized on all processors) C Barycentric Templated 3D Barycentric derived from VectorSpace . Has 4 components, one of which is redundant C is_contiguous< Barycentric< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< Barycentric< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< Barycentric< Cmpt > > Data are contiguous scalar if component type is scalar C BarycentricTensor Templated 4x3 tensor derived from VectorSpace . Has 12 components. Can represent a barycentric transformation as a matrix-barycentric inner-product C is_contiguous< BarycentricTensor< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< BarycentricTensor< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< BarycentricTensor< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfTranspose< Cmpt, BarycentricTensor< Cmpt > > C Barycentric2D Templated 2D Barycentric derived from VectorSpace . Has 3 components, one of which is redundant C is_contiguous< Barycentric2D< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< Barycentric2D< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< Barycentric2D< Cmpt > > Data are contiguous scalar if component type is scalar C pTraits< bool > Template specialisation for pTraits <bool> C Switch A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, any/none. Also accepts 0/1 as a string and shortcuts t/f, y/n C pTraits< char > Template specialisation for pTraits <char> C complex A complex number, similar to the C++ complex type C pTraits_cmptType< complex > The underlying component data type for complex is scalar C pTraits_nComponents< complex > A complex has two scalar components C pTraits< complex > Template specialisation for pTraits<complex> C is_contiguous< complex > Contiguous data for complex C is_contiguous_scalar< complex > Contiguous scalar data for complex C coordinateRotation User specification of a coordinate rotation C coordinateSystem Base class for coordinate system specification, the default coordinate system type is cartesian C iNew Helper for construction of coordinateSystem PtrList C coordinateSystems A centralized collection of named coordinate systems C is_globalIOobject< coordinateSystems > Global file type for coordinateSystems - same content for all ranks C demandDrivenEntry Class for demand-driven dictionary entries C DiagTensor A templated (3 x 3) diagonal tensor of objects of <T>, effectively containing 3 elements, derived from VectorSpace C is_contiguous< DiagTensor< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< DiagTensor< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< DiagTensor< Cmpt > > Data are contiguous scalar if component type is scalar C endian Help with architecture-specific aspects, primarily used as a namespace, but defined as a class to allow pTraits specialization C NamedEnum A NamedEnum is a wrapper around a list of names that represent particular enumeration values C FieldFunction1 C function1Base Base class for template-invariant parts of Function1 C Polynomial Polynomial templated on size (order): C polynomialFunction Polynomial function representation C TimeFunction1 Light wrapper around Function1 to provide a mechanism to update time-based entries C globalIndexAndTransform Determination and storage of the possible independent transforms introduced by coupledPolyPatches, as well as all of the possible permutations of these transforms generated by the presence of multiple coupledPolyPatches, i.e. more than one cyclic boundary. Note that any given point can be on maximum 3 transforms only (and these transforms have to be perpendicular) C less Less function class used in sorting encoded transforms and indices C vectorTensorTransform Vector-tensor class used to perform translations and rotations in 3D space C is_contiguous< vectorTensorTransform > Contiguous data for vectorTensorTransform C Hash Hash function class. The default definition is for primitives. Non-primitives used to hash entries on hash tables will need a specialized version C Hash< std::nullptr_t > Hashing of nullptr, always 0 C Hash< void * > Hashing of pointers, treat as unsigned integer C Hash< bool > Hashing of integral type: bool C Hash< char > Hashing of integral type: char C Hash< int32_t > Hashing of integral type: int32_t C Hash< int64_t > Hashing of integral type: int64_t C Hash< uint32_t > Hashing of integral type: uint32_t C SHA1 Functions to compute SHA1 message digest according to the NIST specification FIPS-180-1 C SHA1Digest The SHA1 message digest C is_contiguous< SHA1Digest > Contiguous data for SHA1Digest C nameOp< int16_t > A word representation of int16 value C pTraits< int16_t > Template specialization for pTraits<int16_t> C nameOp< int32_t > A word representation of int32 value C pTraits< int32_t > Template specialization for pTraits<int32_t> C nameOp< int64_t > A word representation of int64 value C pTraits< int64_t > Template specialization for pTraits<int64_t> C nameOp< int8_t > A word representation of uint8 value C pTraits< int8_t > Template specialization for pTraits<int8_t> C labelOp Conversion/extraction to label operation C labelOp< int32_t > Convert (likely promote) from int32_t to label C labelOp< int64_t > Convert (possibly truncate) from int64_t to label C nameOp< uint16_t > A word representation of uint16 value C pTraits< uint16_t > Template specialization for pTraits<uint16_t> C nameOp< uint32_t > A word representation of uint32 value C pTraits< uint32_t > Template specialization for pTraits<uint32_t> C nameOp< uint64_t > A word representation of uint64 value C pTraits< uint64_t > Template specialization for pTraits<uint64_t> C nameOp< uint8_t > A word representation of uint8 value C pTraits< uint8_t > Template specialization for pTraits<uint8_t> C IndexIterator A random-access, integer-like, input iterator for integral values C ReverseIndexIterator A random-access, integer-like, input iterator for integral values that behaves like a reverse iterator C MatrixSpace Templated matrix space C ConstBlock Const sub-block type C Block Sub-block type C NullObject Singleton null-object class and instance C noOp Same as Foam::identityOp . Should never be specialized C flipOp Functor to negate primitives. Dummy for most other types C flipBoolOp Invert boolean value C flipLabelOp Negate integer values C eqOp2 C eqOp C plusEqOp2 C plusEqOp C minusEqOp2 C minusEqOp C multiplyEqOp2 C multiplyEqOp C divideEqOp2 C divideEqOp C eqMagOp2 C eqMagOp C eqSqrOp2 C eqSqrOp C eqMagSqrOp2 C eqMagSqrOp C plusEqMagSqrOp2 C plusEqMagSqrOp C minEqOp2 C minEqOp C maxEqOp2 C maxEqOp C minMagSqrEqOp2 C minMagSqrEqOp C maxMagSqrEqOp2 C maxMagSqrEqOp C andEqOp2 C andEqOp C orEqOp2 C orEqOp C xorEqOp2 C xorEqOp C bitAndEqOp2 C bitAndEqOp C bitOrEqOp2 C bitOrEqOp C bitXorEqOp2 C bitXorEqOp C eqMinusOp2 C eqMinusOp C nopEqOp2 C nopEqOp C sumOp3 C sumOp2 C sumOp C plusOp3 C plusOp2 C plusOp C minusOp3 C minusOp2 C minusOp C multiplyOp3 C multiplyOp2 C multiplyOp C divideOp3 C divideOp2 C divideOp C cmptMultiplyOp3 C cmptMultiplyOp2 C cmptMultiplyOp C cmptPowOp3 C cmptPowOp2 C cmptPowOp C cmptDivideOp3 C cmptDivideOp2 C cmptDivideOp C stabiliseOp3 C stabiliseOp2 C stabiliseOp C minOp3 C minOp2 C minOp C maxOp3 C maxOp2 C maxOp C minMagSqrOp3 C minMagSqrOp2 C minMagSqrOp C maxMagSqrOp3 C maxMagSqrOp2 C maxMagSqrOp C minModOp3 C minModOp2 C minModOp C bitAndOp3 C bitAndOp2 C bitAndOp C bitOrOp3 C bitOrOp2 C bitOrOp C bitXorOp3 C bitXorOp2 C bitXorOp C andOp2 C andOp C orOp2 C orOp C xorOp2 C xorOp C equalOp2 C equalOp C notEqualOp2 C notEqualOp C lessOp2 C lessOp C lessEqualOp2 C lessEqualOp C greaterOp2 C greaterOp C greaterEqualOp2 C greaterEqualOp C lessEqOp2 C lessEqOp C greaterEqOp2 C greaterEqOp C equalOp1 C notEqualOp1 C lessOp1 C lessEqualOp1 C greaterOp1 C greaterEqualOp1 C multiplyWeightedOp C compareOp Three-way comparison operation of two parameters, C lerpOp Linear interpolation (cf. std::lerp) C lerpOp1 Linear interpolation (lerp) with interpolation value defined on construct C getNameOp Deprecated(2020-11) use nameOp (word.H ) C getTypeOp Deprecated(2020-11) use typeOp (word.H ) C hypotOp Hypot operation (scalar only) C scalarDivideOp Scalar division with divide-by-zero protection C scalarModuloOp Floating point modulo operation with divide-by-zero protection C cubicEqn Container to encapsulate various operations for cubic equation of the forms with real coefficients: C linearEqn Container to encapsulate various operations for linear equation of the forms with real coefficients: C quadraticEqn Container to encapsulate various operations for quadratic equation of the forms with real coefficients: C Roots Templated storage for the roots of polynomial equations, plus flags to indicate the nature of the roots C quaternion Quaternion class used to perform rotations in 3D space C is_contiguous< quaternion > Contiguous data for quaternion C is_contiguous_scalar< quaternion > Contiguous scalar data for quaternion C Rand48 A pseudo random number generator using the linear congruential algorithm with the following parameters: C Random Random number generator C uniformGeneratorOp A generator class returning a uniformly distributed random number on the given interval C gaussianGeneratorOp A generator class returning a gaussian distributed random number C IntRange An interval of (signed) integers defined by a start and a size C gt0 Unary predicate for greater than 0 (int values) C lt0 Unary predicate for less than 0 (int values) C ge0 Unary predicate for greater-equal 0 (int values) C le0 Unary predicate for less-equal 0 (int values) C labelRange A range or interval of labels defined by a start and a size C labelRangeOp Conversion/extraction to labelRange operation (functor) C labelRanges A list of labelRange with constrained list capabilities C const_iterator Forward input iterator with const access C is_contiguous< MinMax< T > > Declare MinMax as non-contiguous (similar to Tuple2 ) C clampOp Unary function for applying component-wise clamping C OffsetRange A tuple of integers comprising start, size, total C scalarRange Scalar bounds to be used as a unary predicate C scalarRanges A collection of scalar bounds to be used as a unary predicate C sliceRange A set of labels defined by a start, a length and a stride C indexer A value indexer, for iteration or generation C const_iterator Bidirectional input iterator with const access C const_reverse_iterator Bidirectional reverse input iterator with const access C RowVector Templated 3D row-vector derived from MatrixSpace adding construction from 3 components and element access using x() , y() and z() C typeOfTranspose< Cmpt, Vector< Cmpt > > C typeOfTranspose< Cmpt, RowVector< Cmpt > > C typeOfSolve< scalar > Type to use for extended precision C pTraits< Scalar > C nameOp< Scalar > A word representation of a floating-point value C compareOp< Scalar > Compare scalar values C equalOp< Scalar > Compare scalar values for equality C notEqualOp< Scalar > Compare scalar values for inequality C floorOp C floorOp< Scalar > Round scalar downwards - functor version of std::floor C ceilOp C ceilOp< Scalar > Round scalar upwards - functor version of std::ceil C roundOp C roundOp< Scalar > Round scalar - functor version of std::round C septernion Septernion class used to perform translations and rotations in 3D space C is_contiguous< septernion > Contiguous data for septernion C is_contiguous_scalar< septernion > Contiguous scalar data for septernion C CompactSpatialTensor Templated 3D compact spatial tensor derived from MatrixSpace used to represent transformations of spatial vectors and the angular and linear inertia of rigid bodies C is_contiguous< CompactSpatialTensor< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< CompactSpatialTensor< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< CompactSpatialTensor< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfInnerProduct< Cmpt, CompactSpatialTensor< Cmpt >, Tensor< Cmpt > > C typeOfInnerProduct< Cmpt, CompactSpatialTensor< Cmpt >, Vector< Cmpt > > C typeOfInnerProduct< Cmpt, SpatialTensor< Cmpt >, CompactSpatialTensor< Cmpt > > C CompactSpatialTensorT Templated 3D transposed compact spatial tensor derived from MatrixSpace used to represent transformations of spatial vectors of rigid bodies C is_contiguous< CompactSpatialTensorT< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< CompactSpatialTensorT< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< CompactSpatialTensorT< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfTranspose< Cmpt, CompactSpatialTensor< Cmpt > > C typeOfTranspose< Cmpt, CompactSpatialTensorT< Cmpt > > C typeOfInnerProduct< Cmpt, CompactSpatialTensor< Cmpt >, CompactSpatialTensorT< Cmpt > > C typeOfInnerProduct< Cmpt, CompactSpatialTensorT< Cmpt >, CompactSpatialTensor< Cmpt > > C typeOfInnerProduct< Cmpt, CompactSpatialTensorT< Cmpt >, SpatialVector< Cmpt > > C SpatialTensor Templated 3D spatial tensor derived from MatrixSpace used to represent transformations of spatial vectors and the angular and linear inertia of rigid bodies C is_contiguous< SpatialTensor< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< SpatialTensor< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< SpatialTensor< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfTranspose< Cmpt, SpatialTensor< Cmpt > > C typeOfOuterProduct< Cmpt, SpatialVector< Cmpt >, SpatialVector< Cmpt > > C typeOfInnerProduct< Cmpt, SpatialTensor< Cmpt >, SpatialVector< Cmpt > > C typeOfInnerProduct< Cmpt, SpatialTensor< Cmpt >, SpatialTensor< Cmpt > > C spatialTransform Compact representation of the Plücker spatial transformation tensor in terms of the rotation tensor E and translation vector r C transpose Wrapper-class to provide transpose functions and operators C dual Wrapper-class to provide dual functions and operators C SpatialVector Templated 3D spatial vector derived from VectorSpace used to represent the anglular and linear components of position, velocity and acceleration of rigid bodies C dual Class to represent the dual spatial vector C is_contiguous< SpatialVector< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< SpatialVector< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< SpatialVector< Cmpt > > Data are contiguous scalar if component type is scalar C Identity Templated identity and dual space identity tensors derived from SphericalTensor C dual The identity type in the dual space C SphericalTensor A templated (3 x 3) diagonal tensor of objects of <T>, effectively containing 1 element, derived from VectorSpace C is_contiguous< SphericalTensor< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< SphericalTensor< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< SphericalTensor< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfSolve< SphericalTensor< Cmpt > > C SphericalTensor2D A templated (2 x 2) diagonal tensor of objects of <T>, effectively containing 1 element, derived from VectorSpace C is_contiguous< SphericalTensor2D< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< SphericalTensor2D< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< SphericalTensor2D< Cmpt > > Data are contiguous scalar if component type is scalar C outerProduct< SphericalTensor2D< Cmpt >, Cmpt > C outerProduct< Cmpt, SphericalTensor2D< Cmpt > > C innerProduct< SphericalTensor2D< Cmpt >, SphericalTensor2D< Cmpt > > C innerProduct< SphericalTensor2D< Cmpt >, Vector2D< Cmpt > > C innerProduct< Vector2D< Cmpt >, SphericalTensor2D< Cmpt > > C outerProduct< SphericalTensor< Cmpt >, Cmpt > C outerProduct< Cmpt, SphericalTensor< Cmpt > > C innerProduct< SphericalTensor< Cmpt >, SphericalTensor< Cmpt > > C innerProduct< SphericalTensor< Cmpt >, Vector< Cmpt > > C innerProduct< Vector< Cmpt >, SphericalTensor< Cmpt > > C Hash< fileName > Hashing for fileName C fileName A class for handling file names C Hash< keyType > Hashing for keyType C keyType A class for handling keywords in dictionaries C CStringList An adapter for copying a list of C++ strings into a list of C-style strings for passing to C code that expects argc/argv parameters C hashedWordList A wordList with hashed named lookup, which can be faster in some situations than using the normal list find/found methods C SubStrings Sub-ranges of a string with a structure similar to std::match_results, but without the underlying regular expression matching C regExpCxx Wrapper around C++11 regular expressions with some additional prefix-handling. The prefix-handling is loosely oriented on PCRE regular expressions and provides a simple means of tuning the expressions C meta Functor wrapper for testing meta-characters C string A class for handling character strings derived from std::string C hasher Hashing functor for string and derived string classes C hash Deprecated hashing functor - use hasher C Hash< string > Hashing for Foam::string C Hash< std::string > Hashing for std:::string C Tuple2 A 2-tuple for storing two objects of dissimilar types. The container is similar in purpose to std::pair, but does not expose its members directly C Hash< word > Hashing for word C word A class for handling words, derived from Foam::string C nameOp Extract name (as a word) from an object, typically using its name() method C typeOp Extract type (as a word) from an object, typically using its type() method C Hash< wordRe > Hashing for wordRe C wordRe A wordRe is a Foam::word , but can contain a regular expression for matching words or strings C wordRes A List of wordRe with additional matching capabilities C matcher Functor wrapper of a list of wordRe for matching C filter Functor wrapper of allow/deny lists of wordRe for filtering C subModelBase Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read and write properties from a dictionary to enable clean re-starts. Used by, e.g. clou dsub-models C is_contiguous< SymmTensor< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< SymmTensor< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< SymmTensor< Cmpt > > Data are contiguous scalar if component type is scalar C symmTypeOfRank< Cmpt, 2 > C typeOfSolve< SymmTensor< Cmpt > > C SymmTensor2D A templated (2 x 2) symmetric tensor of objects of <T>, effectively containing 3 elements, derived from VectorSpace C is_contiguous< SymmTensor2D< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< SymmTensor2D< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< SymmTensor2D< Cmpt > > Data are contiguous scalar if component type is scalar C outerProduct< SymmTensor2D< Cmpt >, Cmpt > C outerProduct< Cmpt, SymmTensor2D< Cmpt > > C innerProduct< SymmTensor2D< Cmpt >, SymmTensor2D< Cmpt > > C innerProduct< SymmTensor2D< Cmpt >, Vector2D< Cmpt > > C innerProduct< Vector2D< Cmpt >, SymmTensor2D< Cmpt > > C typeOfSum< SphericalTensor2D< Cmpt >, SymmTensor2D< Cmpt > > C typeOfSum< SymmTensor2D< Cmpt >, SphericalTensor2D< Cmpt > > C innerProduct< SphericalTensor2D< Cmpt >, SymmTensor2D< Cmpt > > C innerProduct< SymmTensor2D< Cmpt >, SphericalTensor2D< Cmpt > > C outerProduct< SymmTensor< Cmpt >, Cmpt > C outerProduct< Cmpt, SymmTensor< Cmpt > > C innerProduct< SymmTensor< Cmpt >, SymmTensor< Cmpt > > C innerProduct< SymmTensor< Cmpt >, Vector< Cmpt > > C innerProduct< Vector< Cmpt >, SymmTensor< Cmpt > > C typeOfSum< SphericalTensor< Cmpt >, SymmTensor< Cmpt > > C typeOfSum< SymmTensor< Cmpt >, SphericalTensor< Cmpt > > C innerProduct< SphericalTensor< Cmpt >, SymmTensor< Cmpt > > C innerProduct< SymmTensor< Cmpt >, SphericalTensor< Cmpt > > C is_contiguous< Tensor< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< Tensor< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< Tensor< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfRank< Cmpt, 2 > C typeOfTranspose< Cmpt, Tensor< Cmpt > > C typeOfSolve< Tensor< Cmpt > > C Tensor2D A templated (2 x 2) tensor of objects of <T> derived from VectorSpace C is_contiguous< Tensor2D< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< Tensor2D< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< Tensor2D< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfSum< SphericalTensor2D< Cmpt >, Tensor2D< Cmpt > > C typeOfSum< Tensor2D< Cmpt >, SphericalTensor2D< Cmpt > > C innerProduct< Tensor2D< Cmpt >, Tensor2D< Cmpt > > C innerProduct< SphericalTensor2D< Cmpt >, Tensor2D< Cmpt > > C innerProduct< Tensor2D< Cmpt >, SphericalTensor2D< Cmpt > > C innerProduct< Tensor2D< Cmpt >, Vector2D< Cmpt > > C innerProduct< Vector2D< Cmpt >, Tensor2D< Cmpt > > C outerProduct< Vector2D< Cmpt >, Vector2D< Cmpt > > C typeOfSum< SphericalTensor< Cmpt >, Tensor< Cmpt > > C typeOfSum< Tensor< Cmpt >, SphericalTensor< Cmpt > > C innerProduct< SphericalTensor< Cmpt >, Tensor< Cmpt > > C innerProduct< Tensor< Cmpt >, SphericalTensor< Cmpt > > C typeOfSum< SymmTensor< Cmpt >, Tensor< Cmpt > > C typeOfSum< Tensor< Cmpt >, SymmTensor< Cmpt > > C innerProduct< SymmTensor< Cmpt >, Tensor< Cmpt > > C innerProduct< Tensor< Cmpt >, SymmTensor< Cmpt > > C is_contiguous A template class to specify that a data type can be considered as being contiguous in memory C is_contiguous_label A template class to specify if a data type is composed solely of Foam::label elements C is_contiguous_scalar A template class to specify if a data type is composed solely of Foam::scalar elements C one A class representing the concept of 1 (one) that can be used to avoid manipulating objects known to be one at compile-time. It is also used for tagged dispatch C innerProduct< one, arg2 > C zero_one Represents 0/1 range or concept. Used for tagged dispatch or clamping C pTraits A traits class, which is primarily used for primitives and vector-space C pTraits_rank The vector-space rank: default is 0 C pTraits_rank< T, std::void_t< decltype(pTraits< std::remove_cv_t< T > >::rank)> > Rank of VectorSpace , using the pTraits rank static member C pTraits_cmptType The underlying component data type: default is pass-through C pTraits_cmptType< T, std::void_t< decltype(pTraits< std::remove_cv_t< T > >::zero)> > The underlying component data type for vector-space (or complex) C pTraits_nComponents The vector-space number of components: default is 1 C pTraits_nComponents< T, std::void_t< decltype(std::remove_cv_t< T >::nComponents)> > Number of VectorSpace components, using the pTraits nComponents static member C pTraits_has_zero Test for pTraits zero : default is false C pTraits_has_zero< T, std::void_t< decltype(pTraits< std::remove_cv_t< T > >::zero)> > Test for pTraits zero C is_vectorspace Test for VectorSpace : default is false C is_vectorspace< T, std::void_t< decltype(std::remove_cv_t< T >::rank)> > Test for VectorSpace : test for T::rank != 0 static member directly C is_rotational_vectorspace Test for VectorSpace and multiple components (eg, not sphericalTensor ) which means it is not rotationally invariant C is_rotational_vectorspace< T, std::void_t< decltype(std::remove_cv_t< T >::rank), decltype(std::remove_cv_t< T >::nComponents) > > Test for VectorSpace and multiple components (eg, not sphericalTensor ) C is_range Test for containers with begin/end range iterators C is_range< T, std::void_t< decltype(std::declval< T >().begin()), decltype(std::declval< T >().end()) > > Test for list containers with begin/end range iterators C zero A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to be zero at compile-time. It is also used for tagged dispatch C triad Representation of a 3D Cartesian coordinate system as a Vector of row vectors C is_contiguous< triad > Contiguous data for triad C is_contiguous_scalar< triad > Contiguous 'scalar' data for triad C is_contiguous< Pair< T > > Pair is contiguous if the type is contiguous C is_contiguous_label< Pair< T > > Check for Pair of labels C is_contiguous_scalar< Pair< T > > Check for Pair of scalars C Hash< Pair< T > > Hashing for Pair of data C Hash< std::pair< T1, T2 > > Hashing for std::pair data C Hash< Tuple2< T1, T2 > > Hashing for Tuple2 data C minFirstOp Compare tuple-like containers C minFirstEqOp Assign tuple-like container to use the one with the smaller value of first C maxFirstOp Compare tuple-like containers C maxFirstEqOp Assign tuple-like container to use the one with the larger value of first C boolVector Specialized bundling of boolean values as a vector of 3 components, element access using x() , y() and z() member functions. It also has some methods similar to bitSet C is_contiguous< boolVector > A boolVector is contiguous (FixedList of bool) C pTraits_cmptType< boolVector > A boolVector has bool data components C pTraits_nComponents< boolVector > A boolVector has three data components C flux C flux< scalar > C Vector Templated 3D Vector derived from VectorSpace adding construction from 3 components, element access using x() , y() and z() member functions and the inner-product (dot-product) and cross-product operators C is_contiguous< Vector< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< Vector< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< Vector< Cmpt > > Data are contiguous scalar if component type is scalar C typeOfRank< Cmpt, 1 > C symmTypeOfRank< Cmpt, 1 > C typeOfSolve< Vector< Cmpt > > C Vector2D Templated 2D Vector derived from VectorSpace adding construction from 2 components, element access using x() and y() member functions and the inner-product (dot-product) C is_contiguous< Vector2D< Cmpt > > Data are contiguous if component type is contiguous C is_contiguous_label< Vector2D< Cmpt > > Data are contiguous label if component type is label C is_contiguous_scalar< Vector2D< Cmpt > > Data are contiguous scalar if component type is scalar C innerProduct< Vector< Cmpt >, scalar > Dummy innerProduct for scalar C typeOfInnerProduct Abstract template class to provide the form resulting from the inner-product of two forms C typeOfOuterProduct Abstract template class to provide the form resulting from the outer-product of two forms C typeOfTranspose Abstract template class to provide the transpose form of a form C typeOfRank C symmTypeOfRank C typeOfSolve The extended precision type (solveScalar for float) C typeOfMag The magnitude type for given argument C typeOfSum C outerProduct C outerProduct1 Outer-product of identical types C crossProduct C innerProduct C scalarProduct C powProduct C typeOfRank< Cmpt, 0 > C symmTypeOfRank< Cmpt, 0 > C VectorSpace Templated vector space C ConstBlock Const sub-block type C VectorSpaceOps Recursive execution. Terminating at <N>, starting at index <I> C VectorSpaceOps< N, N > Loop termination form, when index and loop count <N> are identical C adjointBoundaryCondition Base class for solution control classes C adjointFarFieldPressureFvPatchScalarField C adjointFarFieldVelocityFvPatchVectorField C adjointInletVelocityFvPatchVectorField C adjointOutletPressureFvPatchScalarField C adjointOutletVelocityFvPatchVectorField Provides the adjoint outlet velocity values (i.e. adjoint velocity in case of a zeroGradient U boundary condition). Can have stability issues in cases of backflow of the primal velocity. The adjointOutletVelocityFlux should preferably be used C adjointOutletVelocityFluxFvPatchVectorField An outlet boundary condition for patches in which the primal flow exhibits recirculation. Adds the contribution of the objective as an adjoint momentum flux directly to the PDEs, without the need to first compute an adjoint outlet velocity, circumventing thus the division with (almost) zero that manifests in case of primal flow recirculation C adjointRotatingWallVelocityFvPatchVectorField The same as adjointWallVelocity but additionally computes the sensitivity contribution emerging from the change in the positions of the face centres, in case rotatingWallVelocity is used for the flow simulation C adjointWallVelocityFvPatchVectorField Adjoint wall velocity boundary condition. If nutUSpaldingWallFunction is employed in the flow solution, the corresponding adjoint wall function is used. Otherwise, the typical low-Re boundary condition is applied C adjointWallVelocityLowReFvPatchVectorField C adjointZeroInletFvPatchField C ATCModel Base class for selecting the adjoint transpose convection model. Inherits from regIOobject to add lookup functionality C ATCstandard The ATC formualtion resulting by differentiating the Non-conservative form of the momentum equations C ATCUaGradU The ATC formualtion resulting by differentiating the Conservative form of the Momentum equations C cancelATC Return a zero ATC field. Seriously influences computed sensitivities C faceCells Smooth ATC in cells next to a set of patches supplied by type C pointCells Smooth ATC in cells having a point to a set of patches supplied by type C zeroATCcells Base class for selecting cells on which to zero the ATC term C boundaryAdjointContribution Abstract base class for computing contributions of the objective functions to the adjoint boundary conditions C boundaryAdjointContributionIncompressible Contributions of objective function differentiation to adjoint boundary conditions for incompressible flows C deltaBoundary Differentiation of the mesh data structure C displacementMethod Abstract base class for displacement methods, which are a set or wrapper classes allowing to change the driving force of mesh motion solvers C displacementMethoddisplacementLaplacian Wrapper class for the displacementLaplacian motion solver C displacementMethodelasticityMotionSolver Wrapper class for the elasticityMotionSolver motion solver C displacementMethodlaplacianMotionSolver Wrapper class for the velocityLaplacian motion solver C displacementMethodpLaplacianMotionSolver Wrapper class for the pLaplacian motion solver C displacementMethodvelocityLaplacian Wrapper class for the velocityLaplacian motion solver C displacementMethodvolumetricBSplinesMotionSolver Wrapper class for the volumetricBSplinesMotionSolver motion solver C elasticityMotionSolver Mesh deformation based on the linear elasticity equations. The boundary displacement is set as a boundary condition on the pointMotionU field C laplacianMotionSolver Similar to velocityLaplacian but iteratively solves the mesh displacement PDEs to account for non-orthogonality. The boundary displacement is set as a boundary condition on pointMotionU; the latter is generated automatically if not found. Assumes uniform diffusivity C pLaplacianMotionSolver Similar to velocityLaplacian but with a variable diffusivity, based on the gradient of the displacement. The boundary displacement is set as a boundary condition on pointMotionU; the latter is generated automatically if not found C volumetricBSplinesMotionSolver A mesh motion solver based on volumetric B-Splines C linearUpwindNormal LinearUpwindNormal interpolation scheme class derived from upwind and returns upwind weighting factors and also applies a gradient-based explicit correction. The magnitude of the correcting gradient is equal to 1 C pointVolInterpolation C volPointInterpolationAdjoint Interpolate from cell centres to points (vertices) using inverse distance weighting C objectiveManager Class for managing objective functions C objectiveGeometric Abstract base class for objective functions that contain only geometric quantities C objectiveIncompressible Abstract base class for objective functions in incompressible flows C objective Abstract base class for objective functions. No point in making this runTime selectable since its children will have different constructors C adjointEikonalSolver Solver of the adjoint to the eikonal PDE C adjointSensitivity Abstract base class for adjoint-based sensitivities C sensitivityMultiple Calculation of adjoint based sensitivities of multiple types C adjointMeshMovementSolver Class solving the adjoint grid dispalcement PDEs. Assumes the primal grid displacement PDE is a Laplace one with uniform diffusivity C sensitivityShapeESI Class for computing sensitivity derivatives using the Enhanced Surface Integral (E-SI) formulation, when a parameterization scheme is inluded through the design variables. Sensitivity maps are implemented in class sensitivitySurfacePoints C sensitivityShapeFI Class for computing Field Integral (FI)-based sensitivity derivatives C ShapeSensitivitiesBase Base class supporting Shape sensitivity derivatives C sensitivitySurface Calculation of adjoint based sensitivities at wall faces C sensitivitySurfacePoints Calculation of adjoint-based sensitivities at wall points using the E-SI formulation C sensitivityTopO C sensitivity Abstract base class for adjoint sensitivities C designVariables Abstract base class for defining design variables C sigmoidalHeaviside A smooth Heaviside function to project the signed distance field in level set topology optimization C smoothHeaviside A smooth Heaviside function to project the signed distance field in level set topology optimization C levelSetDesignVariables Signed distance field design variables for level-set based topology optimization (topO) C BezierDesignVariables Bezier design variables for shape optimisation C shapeDesignVariables Abstract base class for defining design variables for shape optimisation C morphingBoxConstraint Abstract base class for defining constraints for the control points of volumetric B-Splines morphing boxes C noConstraint Applies no constraints to the control points. Enforces the non-overlapping bounds, if present C volumetricBSplinesDesignVariables Volumetric B-Splines design variables for shape optimisation C betaMax Base class for selecting the betaMax value, i.e. the value multiplying the Brinkman penalisation term, for topology optimisation C betaMaxDarcy Compute betaMax through the definition of the Darcy number, quantifying the viscous-to-porous forces ratio Da = nu/betaMax/L/L where nu is the bulk viscosity and L is a characteristic length. The latter is either supplied directly or computed as the C betaMaxReynoldsDarcy Compute betaMax through the products of the Reynolds and Darcy numbers, quantifying the momentum-to-porous forces ratio ReDa = Uref/betaMax/L where Uref is a reference velocity and L is a characteristic length. The latter is either supplied directly or computed as the C betaMaxStepRamp Computes the betaMax using a stepRamp function which updates itself based on the current time C betaMaxValue Read the betaMax value directly C dynamicTopODesignVariables Design variables for topology optimisation problems. Active design variables are added gradually, to help the optimiser from being trapped to a sub-optimal solution track in the first optimisation cycles C BorrvallPeterssonInterpolation Computes the Brickmann penalization function for topO optimisation, proposed by Borrvall and Petersson C expInterpolation Computes the Brickmann penalization function for topology optimisation, relying on exp functions and proposed in C topOInterpolationFunction C invBP Computes the Brickmann penalization function for topology optimisation, based in the inverse of the function proposed by Borrvall and Petersson C linearInterpolation Implements a linear (with respect to beta) term for topology optimisation C SIMPInterpolation Computes the Brickmann penalization function for topology optimisation, using the SIMP approach proposed by Bendsøe C sinhInterpolation Updates the porosity values in topology optimization using a sinh function C tanhInterpolation Computes the Brickmann penalization function for topology optimisation, relying on tanh functions and proposed in C marchingCells C fieldRegularisation C Helmholtz A regulatisation PDE based on a Helmholtz filter C regularisationPDE Base class for selecting the regulatisation PDE C isotropic An isotropic regularisationRadius (same in all spatial directions) C regularisationRadius Base class for selecting the regulatisation radius C topODesignVariables Design variables for porosity-based topology optimisation (topO) problems C topOVariablesBase Base class for all design variables related to topology optimisation (topO). Provides the lookup functionality necessary for all fvOptions associated with topO and access to topOZones C topOZones C ArmijoConditions Class satisfying the Armijo line search conditions C GCMMA Class implementing a workaround for using the Globally converging wrapper of the MMA update method. Implemented as a lineSearch , even though the search direction changes within each inner iteration of GCMMA , due the existing framework for re-solving the primal equations and checking the convergence of a merit function C lineSearch Abstract base class for line search methods C bisection Reduces step by a given ratio C quadratic Fits a quadratic polynomial of the merit function as a function of step and finds the "optimal" value C stepUpdate Abstract base class for step update methods used in line search C designVariablesUpdate A class encapsulating functionality neccessary to perform an optimisation loop, such as updating the design variables, checking the sufficient reduction/adhetion of objective and constraint values in each optimisation cycle by performing a line-search and checking the overall convergence of the optimisation loop, if the corresponding criteria are provided C optimisationManager Abstract base class for optimisation methods C singleRun Update design variables using steepest descent C steadyOptimisation Iterate the optimisation cycles. For steady state opt, this coinsides with evolving Time C BFGS The quasi-Newton BFGS formula. quasiNewton::Hessian corresponds to the inverse Hessian matrix in BFGS C conjugateGradient The Conjugate Gradient formula C constrainedOptimisationMethod Abstract base class for optimisation methods supporting constraints. Does not add functionality to updateMethod but act as a means to categorize constrained optimisation methods for performing sanity checks C constraintProjection Update design variables using Rosen's projection method C DBFGS The quasi-Newton BFGS formula with the dampening proposed by Powell C ISQP An L-BFGS-based SQP algorithm for computing the update of the design variables in the presence of inequality constraints. The QP problem is solved using the interior point method (hence the I in the classe name, which is not standard in the terminology used in the literature). The (potentially dense) linear system formulated by the interior point method is solved using Conjugate Gradient and a choice from three preconditioners (diagonal, inverse Hessian, Sherman-Morrison), using matrix-vector products to avoid storing the LHS matrix C LBFGS The quasi-Newton Limited-memory BFGS formula. Keeps nPrevSteps_ of the y and s vectors and approximates the inverse areas through them. Values of 3 < nPrevSteps_ < 20 are suggested C MMA Update design variables using the Method of Moving Assymptotes. Can handle inequality constraints C nullSpace Update design variables using a null space approach. Can handle inequality and bound constraints C quasiNewton Base class for quasi-Newton methods C SQP The quasi-Newton SQP formula for constrained optimisation C SQPBase Base class for Sequantial Quadratic Programming (SQP ) methods C SR1 The quasi-Newton Symmetric Rank One formula. The quasiNewton::Hessian corresponds to Hessian inverse for SR1 C steepestDescent Update design variables using steepest descent C updateMethod Abstract base class for optimisation methods C Bezier Calculation of adjoint based sensitivities for Bezier control points C NURBS3DCurve A NURBS 3D curve C NURBS3DSurface A NURBS 3D surface C NURBS3DVolumeCartesian Calculation of adjoint based sensitivities at wall faces C axisAligned Defines control points aligned with coordinate system C controlPointsDefinition Abstract base for selecting how to construct the control points of a volumetric B-Splines morpher C fromFile Reads control points from constant/controlPoints C transformBox Defines control points based on given lower and upper boundaries for the box and additional translation, rotation and scaling vectors. The latter can be copied over from the Paraview clip or transform filters, to facilitate the definition of a more general box C NURBS3DVolumeCylindrical Calculation of adjoint based sensitivities at wall faces C NURBS3DVolume NURBS3DVolume morpher. Includes support functions for gradient computations Base class providing support for different coordinate systems C volBSplinesBase Class constructing a number of volumetric B-Splines boxes, read from dynamicMeshDict. Useful for various sensitivities and optMeshMovement classes C NURBSbasis NURBSbasis function. Used to construct NURBS curves, surfaces and volumes C adjointSolverManager Class for managing adjoint solvers, which may be more than one per operating point C adjointSolver Base class for adjoint solvers C adjointSimple Solution of the adjoint PDEs for incompressible, steady-state flows C incompressibleAdjointSolver Base class for incompressibleAdjoint solvers C adjointNull Dummy adjoint solver. Used to add the derivatives of geometric constraints which do not require the solution of adjoint PDEs C incompressiblePrimalSolver Base class for primal incompressible solvers C RASTurbulenceModel Solves for a RAS turbulence model, with constant U and phi values C simple Base class for solution control classes C primalSolver Base class for primal solvers C solver Base solver class C SIMPLEControlOpt SIMPLE control class for optimisation runs. Each time is sub-cycled and corresponds to one optimisation cycle C SIMPLEControl SIMPLE control class to supply convergence information/checks for the SIMPLE loop C SIMPLEControlSingleRun SIMPLE control class for single runs (i.e. not optimisation). Time acts as in simpleFoam, with all solver control read through optimisationDict C solverControl Base class for solver control classes C incompressibleVars Base class for solution control classes C incompressibleAdjointVars Class including all adjoint fields for incompressible flows C incompressibleAdjointMeanFlowVars Manages the adjoint mean flow fields and their mean values C variablesSet Base class for creating a set of variables C adjointFarFieldNuaTildaFvPatchScalarField C adjointFarFieldTMVar1FvPatchScalarField C adjointFarFieldTMVar2FvPatchScalarField C adjointInletNuaTildaFvPatchScalarField Inlet boundary for adjoint nuaTilda C adjointOutletFluxFvPatchField C adjointOutletKaFvPatchScalarField C adjointOutletNuaTildaFvPatchScalarField C adjointOutletNuaTildaFluxFvPatchScalarField C adjointOutletWaFvPatchScalarField C kaqRWallFunctionFvPatchScalarField C waWallFunctionFvPatchScalarField C cpuInfo General CPU characteristics C cpuTimePosix Starts timing CPU usage and return elapsed time from start C reduceFileStates Reduction operator for PackedList of fileState C combineReduceFileStates Combine operator for PackedList of fileState C fileMonitorWatcher Internal tracking via stat(3p) or inotify(7) C fileMonitor Checking for changes to files C fileStat Wrapper for stat() and lstat() system calls C memInfo Memory usage information for the current process, and the system memory that is free C sigFpe Set up trapping for floating point exceptions (signal FPE) C ignore Helper to locally ignore SIGFPE handling C sigInt Signal handler for INT interrupt C sigQuit Signal handler for QUIT interrupt C sigSegv Signal handler for SEGV interrupt C sigStopAtWriteNow Signal handler to write and stop the job. The interrupt is defined by OptimisationSwitches::stopAtWriteNowSignal C sigWriteNow Signal handler to write once and continue. The interrupt is defined by OptimisationSwitches::writeNowSignal C timer Implements a timeout mechanism via sigalarm C cellCellStencil Calculation of interpolation stencils C cellCellStencilObject C meshToMeshData Transfers refinement levels such that slow transition between levels is maintained. Used in FaceCellWave C trackData Class used to pass non-cell data to the update function C is_contiguous< meshToMeshData > Contiguous data for meshToMeshData C is_contiguous_label< meshToMeshData > Contiguous label data for meshToMeshData C waveMethod Direct (one-to-one cell correspondence) mesh-to-mesh interpolation class C voxelMeshSearch Fast, non-parallel searching in mesh without use of octree C fvMeshPrimitiveLduAddressing Variant of fvMeshLduAddressing that contains addressing instead of slices C calculatedProcessorGAMGInterface GAMG agglomerated processor interface C calculatedProcessorGAMGInterfaceField GAMG agglomerated processor interface field C oversetGAMGInterface GAMG agglomerated cyclic AMI interface C oversetGAMGInterfaceField GAMG agglomerated C oversetLduInterface An abstract base class for overset coupled interfaces C oversetLduInterfaceField Abstract base class for overset coupled interface fields C dynamicOversetFvMesh DynamicFvMesh with support for overset meshes C oversetFvMeshBase Support for overset functionality C staticOversetFvMesh FvMesh with support for overset meshes C oversetFvPatch Patch for indicating interpolated boundaries (in overset meshes) C oversetFvPatchField Boundary condition for use on overset patches. To be run in combination with special dynamicFvMesh type that inserts interpolation into the matrix C oversetPolyPatch Patch for indicating interpolated boundaries (in overset meshes) C regionsToCell TopoSetSource. Select cells belonging to topological connected region (that contains given points) C decompositionInformation Abstract base class for decomposition C decompositionModel MeshObject wrapper of decompositionMethod C dimFieldDecomposer Dimensioned field decomposer C fvFieldDecomposer Finite Volume volume and surface field decomposer C patchFieldDecomposer Patch field decomposer class C processorVolPatchFieldDecomposer Processor patch field decomposer class. Maps either owner or C processorSurfacePatchFieldDecomposer Processor patch field decomposer class. Surface field is assumed C fieldsCache C lagrangianFieldDecomposer Lagrangian field decomposer C fieldsCache C pointFieldDecomposer Point field decomposer C patchFieldDecomposer Point patch field decomposer class C fieldsCache C decompositionGAMGAgglomeration Agglomerate using the decomposition algorithm C decompositionConstraint Abstract class for handling decomposition constraints C decompositionMethod Abstract base class for domain decomposition C geomDecomp Base for geometrical domain decomposition methods C hierarchGeomDecomp Does hierarchical decomposition of points, selectable as hierarchical C manualDecomp Decompose based on cell-to-processor association in a file C metisLikeDecomp Domain decomposition using METIS-like data structures C multiLevelDecomp Decompose given using consecutive application of decomposers C noDecomp A dummy decomposition method, selected as none C randomDecomp Decomposition according to pseudo-random number generator, which is useful for development and stress testing implementations but obviously sub-optimal for normal uses. Can optionally specify the number of consecutive cells to assign to the same processor (agglomeration) C vectorLessOp C simpleGeomDecomp Simple geometric decomposition, selectable as simple C structuredDecomp Walk out decomposition of patch cells mesh - selectable as structured C faFieldDecomposer Finite Area area and edge field decomposer C patchFieldDecomposer Patch field decomposer class C processorAreaPatchFieldDecomposer Processor patch field decomposer class C processorEdgePatchFieldDecomposer Processor patch field decomposer class C fieldsCache C faMeshDecomposition Automatic faMesh decomposition class C kahipDecomp Domain decomposition using KaHIP http://algo2.iti.kit.edu/documents/kahip/ C metisDecomp Metis domain decomposition C ptscotchDecomp PTScotch domain decomposition C scotchDecomp Scotch domain decomposition C volumeCombineOp Combine operator for volume types C nearestEqOp C distributedTriSurfaceMesh IOoject and searching on distributed triSurface . All processor hold (possibly overlapping) part of the overall surface. All queries are distributed to the processor that can answer it and the result sent back C is_globalIOobject< distributedTriSurfaceMesh > Global file type for distributedTriSurfaceMesh C faFieldReconstructor Finite Area area and edge fields reconstruction C faPatchFieldReconstructor C faMeshReconstructor A bare-bones reconstructor for finiteArea meshes when processor meshes are available (in parallel) but an equivalent serial faMesh is needed for reconstruction or decomposition. In these situations, a serial version of the faMesh is needed, but preferably without reconstructing the entire volume mesh C processorFaMeshes Container for finite-area processor mesh addressing C fvFieldReconstructor Finite volume reconstructor for volume and surface fields C fvPatchFieldReconstructor Mapper for sizing only - does not do any actual mapping C lagrangianReconstructor Reconstructor for lagrangian positions and fields C passivePositionParticle Copy of base particle but without particle locating and preserving read location C iNew Factory class to read-construct particles (for parallel transfer) C passivePositionParticleCloud A Cloud of passive particles C pointFieldReconstructor Point field reconstructor C pointPatchFieldReconstructor C processorMeshes Container for processor mesh addressing C multiphaseSystem Incompressible multi-phase mixture with built in solution for the phase fractions with interface compression for interface-capturing C interfacePair Name pair for the interface C phaseModel Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations C iNew Return a pointer to a new phase created on freestore C timeVaryingMassSorptionFvPatchScalarField This boundary condition provides a first order fixed-value condition for a given scalar field to model time-dependent adsorption-desoprtion processes to be used with the interfaceOxideRate C pureMixture Foam::pureMixture C multiComponentMixture Foam::multiComponentMixture C InterfaceCompositionModel Base class for interface composition models, templated on the two thermodynamic models either side of the interface C porousModel C MassTransferPhaseSystem Class for mass transfer between phases C multiphaseInterSystem C MovingPhaseModel Class which represents a moving fluid phase. Holds the velocity, fluxes and turbulence model. Provides access to the turbulent quantities C MultiComponentPhaseModel Class which represents a phase with multiple species. Returns the species' mass fractions, and their governing equations C PurePhaseModel Class which represents pure phases, i.e. without any species. Returns an empty list of mass fractions C StaticPhaseModel Class which represents a static fluid phase C orderedPhasePair C phasePair Description for mass transfer between a pair of phases. The direction of the mass transfer is from the phase 'from' to the phasse 'to' C const_iterator STL const_iterator C phasePairKey An ordered or unorder pair of phase names. Typically specified as follows C hasher Hashing functor for phasePairKey C Hash< phasePairKey > Hashing for phasePairKey C blendedInterfacialModel C BlendedInterfacialModel C blendingMethod C copiedFixedValueFvPatchScalarField Copies the boundary values from a user specified field C fixedMultiPhaseHeatFluxFvPatchScalarField Calculates a wall temperature that produces the specified overall wall heat flux across all the phases in an Eulerian multi-phase simulation C diameterModel Abstract base-class for dispersed-phase particle diameter models C interfaceCompositionModel Generic base class for interface models. Mass transfer models are interface models between two thermos. Abstract class for mass transfer functions C massTransferModel C aspectRatioModel C dragModel C heatTransferModel C liftModel C phaseTransferModel C swarmCorrection C turbulentDispersionModel C virtualMassModel C wallDampingModel C wallDependentModel A class which provides on-demand creation and caching of wall distance and wall normal fields for use by multiple models C wallLubricationModel C AnisothermalPhaseModel Class which represents a phase for which the temperature (strictly energy) varies. Returns the energy equation and corrects the thermodynamic model C InertPhaseModel Class which represents an inert phase, with no reactions. Returns zero reaction rate and heat C IsothermalPhaseModel Class which represents a phase for which the temperature (strictly energy) remains constant. Returns an empty energy equation and does nothing when correctThermo is called C ReactingPhaseModel Class which represents phases with volumetric reactions. Returns the reaction rate and heat C StationaryPhaseModel Class which represents a stationary (and therefore probably solid) phase. Generates, but does not store, zero velocity and flux field and turbulent qauantities. Throws an error when non-const access is requested to the motion fields or when the momentum equation is requested. Usage must must protect against such calls C ThermoPhaseModel Class which represents a phase with a thermodynamic model. Provides access to the thermodynamic variables. Note that the thermo model itself is not returned as this class could be substituted in the hierarchy for one which mirrors the functionality, but does not include a thermo model; an incompressible phase model, for example C phaseSystem Class to represent a system of phases and model interfacial transfers between them C InterfaceCompositionPhaseChangePhaseSystem Class to provide interfacial heat and mass transfer between a number of phases according to a interface composition model C MomentumTransferPhaseSystem Class which models interfacial momenum transfer between a number of phases. Drag, virtual mass, lift, wall lubrication and turbulent dispersion are all modelled. The explicit contribution from the drag is omitted from the transfer matrices, as this forms part of the solution of the pressure equation C OneResistanceHeatTransferPhaseSystem Class which models interfacial heat transfer between a number of phases. A single heat transfer model is used for each interface C PhaseTransferPhaseSystem Class which models non-thermally-coupled mass transfers; i.e., representation changes, rather than phase changes C PopulationBalancePhaseSystem Class which provides population balance functionality C ThermalPhaseChangePhaseSystem Class to provide interfacial heat and mass transfer between a number of phases according the interfacial temperature approximated by the saturation temperature C TwoResistanceHeatTransferPhaseSystem Class which models interfacial heat transfer between a number of phases. Two heat transfer models are stored at each interface, one for each phase. This permits definition of an interface temperature with which heat transfer occurs. It also allows derived systems to define other thermodynamic properties at the interface and therefore represent phase changes C PhaseCompressibleTurbulenceModel Templated abstract base class for multiphase compressible turbulence models C ThermalDiffusivity Templated wrapper class to provide compressible turbulence models thermal diffusivity based thermal transport C saturationModel C JohnsonJacksonParticleSlipFvPatchVectorField Partial slip boundary condition for the particulate velocity C JohnsonJacksonParticleThetaFvPatchScalarField Robin condition for the particulate granular temperature C twoPhaseSystem Class which solves the volume fraction equations for two phases C incompressibleInterPhaseTransportModel Transport model selection class for the incompressibleInterFoam family of solvers C fft Fast fourier transform using the fftw library C Kmesh Calculate the wavenumber vector field corresponding to the space vector field of a finite volume mesh; C noiseFFT Performs FFT of pressure field to generate noise data C noiseModel Base class for noise models C planInfo FFTW planner information C octaveBandInfo Octave band information C UOprocess Random UO process C turbGen Generate a turbulent velocity field conforming to a given energy spectrum and being divergence free C windowModel Base class for windowing models C velocityFilmShellFvPatchVectorField C vibrationShellFvPatchScalarField C filmSeparationModel A base class for filmSeparation models C filmPyrolysisRadiativeCoupledMixedFvPatchScalarField Mixed boundary condition for temperature, to be used in the flow and pyrolysis regions when a film region model is used C filmPyrolysisTemperatureCoupledFvPatchScalarField This boundary condition is designed to be used in conjunction with surface film and pyrolysis modelling. It provides a temperature boundary condition for patches on the primary region based on whether the patch is seen to be 'wet', retrieved from the film alpha field C filmPyrolysisVelocityCoupledFvPatchVectorField This boundary condition is designed to be used in conjunction with surface film and pyrolysis modelling C mappedVariableThicknessWallFvPatch Take thickness field and number of layers and returns deltaCoeffs as 2.0/thickness/nLayers. To be used with 1D thermo baffle C filmHeightInletVelocityFvPatchVectorField This boundary condition is designed to be used in conjunction with surface film modelling. It provides a velocity inlet boundary condition for patches where the film height is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces using: C inclinedFilmNusseltHeightFvPatchScalarField Film height boundary condition for inclined films that imposes a sinusoidal perturbation on top of a mean flow rate, where the height is calculated using the Nusselt solution C inclinedFilmNusseltInletVelocityFvPatchVectorField Film velocity boundary condition for inclined films that imposes a sinusoidal perturbation on top of a mean flow rate, where the velocity is calculated using the Nusselt solution C CuthillMcKeeRenumber Cuthill-McKee renumbering (CM or RCM) C reverseCuthillMcKeeRenumber Reverse Cuthill-McKee renumbering C manualRenumber Renumber given a ordered-to-original cell association in a file C noRenumber A dummy renumber method, selected as none C randomRenumber Random renumber. Just to see effect of renumbering C renumberMethod Abstract base class for renumbering C springRenumber Use spring analogy - attract neighbouring cells according to the distance of their cell indices C OppositeFaceCellWaveBase C OppositeFaceCellWave Version of FaceCellWave that walks through prismatic cells only C structuredRenumber Renumbering according to mesh layers. depthFirst = true: first column gets ids 0..nLayer-1, second nLayers..2*nLayers-1 etc. depthFirst = false: first layer gets ids 0,1,2 etc C layerLess Function class for sorting according to column and layer C SloanRenumber Sloan renumbering algorithm C zoltanRenumber Use Zoltan C rigidBodyMeshMotion Rigid-body mesh motion solver for fvMesh C rigidBodyMeshMotionSolver Rigid-body mesh motion solver for fvMesh C cellVolumeWeightMethod Cell-volume-weighted mesh-to-mesh interpolation class C correctedCellVolumeWeightMethod Cell-volume-weighted mesh-to-mesh interpolation class C directMethod Direct (one-to-one cell correspondence) mesh-to-mesh interpolation class C mapNearestMethod Map nearest mesh-to-mesh interpolation class C meshToMeshMethod Base class for mesh-to-mesh calculation methods C distributedWeightedFvPatchFieldMapper FieldMapper with weighted mapping from (optionally remote) quantities C meshToMesh Class to calculate the cell-addressing between two overlapping meshes C meshToMesh0 Serial mesh to mesh interpolation class C patchFieldInterpolator Patch-field interpolation class C patchProbes Probes the specified points on specified patches. The points get snapped onto the nearest point on the nearest face of the specified patch, and the sampling is actioned on the snapped locations C internalFieldProbe A utility class for probing field values at specified point locations within an fvMesh C patchFieldProbe Utility class for probing specified points on user-selected boundary patches. The input points are projected onto the nearest point of the nearest face on the specified patch, ensuring sampling occurs at valid patch locations C probeModel Base class for sampling fields at specified internal and boundary locations C isNotEqOp C probes Function object to sample fields at specified internal-mesh locations and write to file C Probes Base class for sampling fields at specified locations and writing to file. The locations are specified and determined in the derived class. The sampling is done using the specified point probeModel class C fieldGroup Grouping of field names by GeometricField type C abaqusMeshSet Generates sample positions from points specified in a file as Abaqus mesh points C arraySet Specifies an x,y,z array of uniformly distributed sampling points C cellCentreSet A sampleSet based on cell centres C circleSet Samples along a circular path C cloudSet Samples at arbitrary locations with a volume mesh C faceOnlySet Sample on faces along a specified path C midPointSet C midPointAndFaceSet C patchCloudSet Like Foam::cloudSet but samples nearest patch face C patchEdgeSet Like Foam::uniformSet but samples patch edges C patchSeedSet Initialises points on or just off patch C polyLineSet Sample along poly line defined by a list of points (knots) C sampledSet Holds list of sampling points which is filled at construction time. Various implementations of this base class to e.g. get sampling points at uniform distance along a line (uniformSet ) or directly specified (cloudSet ) C iNew Class used for the read-construction of C iNewCapture PtrList read-construction helper that captures dictionaries used during creation C sampledSets Set of sets to sample C shortestPathSet Finds shortest path (in terms of cell centres) to walk on mesh from any point in insidePoints to any point in outsidePoints C triSurfaceMeshPointSet A sampleSet from all points of a triSurfaceMesh C uniformSet A sampler type which provides a uniform distribution of nPoints sample locations along a straight line specified between a given start and an end points C sampledDistanceSurface A sampledSurface defined by a distance to a surface - resolved using an iso-surface (algorithm: cell, point, topo) C sampledIsoSurface A sampledSurface defined by a surface of iso value. It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects C sampledIsoSurfaceCell A sampledSurface defined by a surface of iso value using a cell algorithm. It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects C sampledIsoSurfacePoint A sampledSurface defined by a surface of iso value using a point algorithm (always triangulated!). It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects C sampledIsoSurfaceTopo A sampledSurface defined by a surface of iso value using a topo algorithm. It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects C sampledCuttingPlane A sampledSurface defined by a plane using an iso-surface algorithm to cut the mesh C sampledCuttingSurface A surface define by using an input surface to cut the mesh cells C sampledFaceZone A sampledSurface defined by a faceZone or faceZones C sampledMeshedSurface A sampledSurface from a meshed surface. It samples on the points/faces of the meshed surface C sampledMeshedSurfaceNormal Variant of sampledMeshedSurface that samples the surface-normal component of a vector field C sampledNone A no operation sampledSurface that can be used when a sampler is expected but is not desired. For example, to temporarily disable a sampling definition, or to provide a boilerplate definition that is overwritten at a later stage in a dictionary C sampledPatch A sampledSurface on patches. Non-triangulated by default C sampledPatchInternalField Variation of sampledPatch that samples the internalField (at a given normal distance from the patch) instead of the patchField. Note: C sampledPlane A sampledSurface defined by a plane which cuts the mesh using the cuttingPlane alorithm. The surface is triangulated by default C sampledSurface An abstract class for surfaces with sampling C iNew PtrList read-construction helper C iNewCapture PtrList read-construction helper that captures dictionaries used during creation C sampledSurfaces Set of surfaces to sample C sampledThresholdCellFaces A sampledSurface defined by the cell faces corresponding to a threshold value C cuttingPlane Constructs cutting plane through a mesh C cuttingSurface Constructs a cutting surface through a mesh C cuttingSurfaceBase Base for creating a MeshedSurface by performing some type of cell cutting/intersection C distanceSurface A surface defined by a distance from an input searchable surface. Uses an iso-surface algorithm (cell, topo, point) for constructing the distance surface C isoSurfaceBase Low-level components common to various iso-surface algorithms C isoSurfaceCell A surface formed by the iso value. After "Polygonising A Scalar Field Using Tetrahedrons", Paul Bourke (http://paulbourke.net/geometry/polygonise ) and "Regularised Marching Tetrahedra: improved iso-surface extraction", G.M. Treece, R.W. Prager and A.H. Gee C isoSurfaceParams Preferences for controlling iso-surface algorithms C storeOp C isoSurfacePoint A surface formed by the iso value. After "Regularised Marching Tetrahedra: improved iso-surface extraction", G.M. Treece, R.W. Prager and A.H. Gee C isoSurfaceTopo Marching tet iso surface algorithm with optional filtering to keep only points originating from mesh edges C thresholdCellFaces Selects the mesh cell faces specified by a threshold value. Non-triangulated by default C sixDoFRigidBodyDisplacementPointPatchVectorField Foam::sixDoFRigidBodyDisplacementPointPatchVectorField C uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField Foam::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField C sixDoFRigidBodyMotionConstraint Base class for defining constraints for sixDoF motions C sixDoFRigidBodyMotionRestraint Base class for defining restraints for sixDoF motions C sixDoFRigidBodyMotion Six degree of freedom motion for a rigid body C sixDoFRigidBodyMotionState Holds the motion state of sixDoF object. Wrapped up together to allow rapid scatter to other processors. The processors must all maintain exactly the same state data to avoid any drift or inconsistency C sixDoFRigidBodyMotionSolver 6-DoF solid-body mesh motion solver for an fvMesh C sixDoFSolver C mergedSurf Simple class to manage surface merging information C meshedSurf Abstract definition of a meshed surface defined by faces and points C emptySurface A concrete meshedSurf class without faces, points, etc C meshedSurfRef Implements a meshed surface by referencing another meshed surface or faces/points components C MeshedSurfaceProxy A proxy for writing MeshedSurface , UnsortedMeshedSurface and surfMesh to various file formats C UnsortedMeshedSurface A surface geometry mesh, in which the surface zone information is conveyed by the 'zoneId' associated with each face C ModifiableMeshedSurface A special purpose MeshedSurface that exposes the stored values for direct modification C polySurfaceGeoMesh The polySurface GeoMesh for face fields C polySurfacePointGeoMesh The polySurface GeoMesh for point fields C polySurface A surface mesh consisting of general polygon faces and capable of holding fields C boundaryDataSurfaceReader A boundaryData format surface reader. However, the "surface" represented by boundaryData is actually only point data! C surfaceReader Abstract base class for surface readers with fields C ensightSurfaceReader Ensight format surface reader C surfaceRegistry Wraps the normal objectRegistry with a local instance for surfaces C surfGeoMesh The surfMesh GeoMesh for face fields C surfPointGeoMesh The surfMesh GeoMesh for point fields C surfMesh A surface mesh consisting of general polygon faces that has IO capabilities and a registry for storing fields C surfZone A surface zone on a MeshedSurface C labelRangeOp< surfZone > The labelRange of a surfZone C surfZoneIOList IOobject for a surfZoneList C triSurfaceGeoMesh The triSurface GeoMesh (for holding face fields) C triSurfacePointGeoMesh C surfacePatch A 'patch' on surface as subset of triSurface C triSurface Triangulated surface description with patch information C surfaceWriter Base class for surface writers C barotropicCompressibilityModel Abstract class for barotropic compressibility models C basicThermo Abstract base-class for fluid and solid thermodynamic properties C energyJumpFvPatchScalarField This boundary condition provides an energy jump condition across a pair of coupled patches. It is not applied directly, but is employed on-the-fly when converting temperature boundary conditions into energy C energyJumpAMIFvPatchScalarField This boundary condition provides an energy jump condition across a pair of coupled patches with an arbitrary mesh interface (AMI). It is not applied directly, but is employed on-the-fly when converting temperature boundary conditions into energy C fixedEnergyFvPatchScalarField This boundary condition provides a fixed condition for internal energy C gradientEnergyFvPatchScalarField This boundary condition provides a gradient condition for internal energy, where the gradient is calculated using: C mixedEnergyFvPatchScalarField This boundary condition provides a mixed condition for internal energy C fluidThermo Fundamental fluid thermodynamic properties C heThermo Enthalpy/Internal energy for a mixture C basicMixture Foam::basicMixture C pureZoneMixture Version of pureMixture that uses different mixtures for different cellZones. Every cellZone has to provide an entry for its mixture. A reserved entry 'none' is for all unzoned cells C hePsiThermo Energy for a mixture based on compressibility C psiThermo Basic thermodynamic properties based on compressibility C heRhoThermo Energy for a mixture based on density C rhoThermo Basic thermodynamic properties based on density C BasicChemistryModel Basic chemistry model templated on thermodynamics C basicChemistryModel Base class for chemistry models C StandardChemistryModel Extends base chemistry model by adding a thermo package, and ODE functions. Introduces chemistry equation system and evaluation of chemical source terms C TDACChemistryModel Extends StandardChemistryModel by adding the TDAC method C chemistryReductionMethod An abstract class for methods of chemical mechanism reduction C SortableListDRGEP A list that is sorted upon construction or when explicitly requested with the sort() method C less Less function class used by the sort function C SortableListEFA A list that is sorted upon construction or when explicitly requested with the sort() method C more Less function class used by the sort function C chemistryTabulationMethod An abstract class for chemistry tabulation C binaryNode Node of the binary tree C binaryTree Data storage of the chemistryOnLineLibrary according to a binary tree structure C chemPointISAT Leaf of the binary tree. The chemPoint stores the composition 'phi', the mapping of this composition Rphi, the mapping gradient matrix A and the matrix describing the Ellipsoid Of Accuracy (EOA) C chemistrySolver An abstract base class for solving chemistry C EulerImplicit An Euler implicit solver for chemistry C noChemistrySolver Dummy chemistry solver for 'none' option C ode An ODE solver for chemistry C laminarFlameSpeed Abstract class for laminar flame speed C faceReflecting Calculates the reflecting faces from specular surfaces. It only takes into account the first reflection coming from a surface hit by the primary Sun hit faces C faceShading Helper class to calculate visible faces for global, sun-like illumination C solarCalculator A solar calculator model providing models for the solar direction and solar loads C chemistryReader Abstract class for reading chemistry C chemkinReader Foam::chemkinReader C foamChemistryReader Chemistry reader for OpenFOAM format C boundarySourcePatch Pure virtual class for sources on cells next to patches C enthalpySorptionFvPatchScalarField This is a temperature boundary condition which works in conjunction with the speciesSorption condition for species C fixedUnburntEnthalpyFvPatchScalarField Fixed boundary condition for unburnt C gradientUnburntEnthalpyFvPatchScalarField Gradient boundary condition for unburnt C mixedUnburntEnthalpyFvPatchScalarField Mixed boundary condition for unburnt C speciesSorptionFvPatchScalarField This boundary condition provides a first-order zero-gradient condition for a given scalar field to model time-dependent adsorption-desorption processes C moleFractions Calculates mole-fraction fields from the mass-fraction fields of the psi/rhoReactionThermo and caches them for output and further post-processing C basicCombustionMixture Specialization of the basicSpecieMixture for combustion C basicMultiComponentMixture Multi-component mixture C basicSpecieMixture Specialization of basicMultiComponentMixture for a mixture consisting of a number for molecular species C egrMixture The egr mixture contains species ("ft", "b", "egr") C homogeneousMixture The homogeneous mixture contains species ("b") C inhomogeneousMixture The inhomogeneous mixture contains species ("ft", "b") C reactingMixture Foam::reactingMixture C singleComponentMixture Single component mixture C singleStepReactingMixture Single step reacting mixture C SpecieMixture Foam::SpecieMixture C veryInhomogeneousMixture The very inhomogeneous mixture contains species ("ft", "fu", "b") C psiReactionThermo Foam::psiReactionThermo C heheuPsiThermo C psiuReactionThermo Foam::psiuReactionThermo C rhoReactionThermo Foam::rhoReactionThermo C SLGThermo Thermo package for (S)olids (L)iquids and (G)ases Takes reference to thermo package, and provides: C basicSolidChemistryModel Chemistry model for solid thermodynamics C pyrolysisChemistryModel Pyrolysis chemistry model. It includes gas phase in the solid reaction C solidChemistryModel Extends base solid chemistry model by adding a thermo package, and ODE functions C solidArrheniusReactionRate Arrhenius reaction rate for solids C solidIsothermalReactionRate Isothermal reaction rate for solids C solidReaction Read solid reactions of the type S1 = S2 + G1 C constAnIsoSolidTransport Constant properties Transport package. Templated into a given Thermodynamics package (needed for thermal conductivity) C constIsoSolidTransport Constant properties Transport package. Templated into a given thermodynamics package (needed for thermal conductivity) C exponentialSolidTransport Exponential properties for solid heat transport Templated into a given thermodynamics package C polynomialSolidTransport Transport package using polynomial functions for solid kappa C tabulatedAnIsoSolidTransport Transport properties package using Function1 C tabulatedSolidTransport Transport properties package using non-uniform tabulated data for thermal conductivity vs temperature C solidReactionThermo Foam::solidReactionThermo C heSolidThermo Energy for a solid mixture C solidThermo Fundamental solid thermodynamic properties C atomicWeightTable A table of atomic weights for all the elements C atomicWeight Structure to hold the element name and atomic weight pair C adiabaticPerfectFluid Adiabatic perfect fluid equation of state C Boussinesq Incompressible gas equation of state using the Boussinesq approximation for the density as a function of temperature only: C icoPolynomial Incompressible, polynomial form of equation of state, using a polynomial function for density C icoTabulated Incompressible of equation of state using non-uniform tabulated density vs temperature C incompressiblePerfectGas Incompressible gas equation of state using a constant reference pressure in the perfect gas equation of state rather than the local pressure so that the density only varies with temperature and composition C PengRobinsonGas PengRobinsonGas gas equation of state C perfectFluid Perfect gas equation of state C perfectGas Perfect gas equation of state C rhoConst RhoConst (rho = const) of state C rPolynomial Reciprocal polynomial equation of state for liquids and solids C ArrheniusReactionRate Arrhenius reaction rate given by: C ChemicallyActivatedReactionRate General class for handling chemically-activated bimolecular reactions C LindemannFallOffFunction Lindemann fall-off function C SRIFallOffFunction The SRI fall-off function C TroeFallOffFunction The Troe fall-off function C FallOffReactionRate General class for handling unimolecular/recombination fall-off reactions C infiniteReactionRate Infinite reaction rate C JanevReactionRate Janev, Langer, Evans and Post reaction rate C LandauTellerReactionRate Landau-Teller reaction rate C LangmuirHinshelwoodReactionRate Power series reaction rate C powerSeriesReactionRate Power series reaction rate C thirdBodyArrheniusReactionRate Arrhenius reaction rate enhanced by third-body interaction C thirdBodyEfficiencies Third body efficiencies C IrreversibleReaction Simple extension of Reaction to handle reversible reactions using equilibrium thermodynamics C NonEquilibriumReversibleReaction Simple extension of Reaction to handle reversible reactions using equilibrium thermodynamics C Reaction Simple extension of ReactionThermo to handle reaction kinetics in addition to the equilibrium thermodynamics already handled C specieCoeffs Hold specie index and its coefficients in the reaction rate expression C ReactionList List of templated reactions C ReversibleReaction Simple extension of Reaction to handle reversible reactions using equilibrium thermodynamics C specie Base class of the thermophysical property types C specieElement C absoluteEnthalpy Thermodynamics mapping class to expose the absolute enthalpy functions C absoluteInternalEnergy Thermodynamics mapping class to expose the absolute internal energy functions C eConstThermo Constant properties thermodynamics package templated on an equation of state C hConstThermo Constant properties thermodynamics package templated into the EquationOfState C hPolynomialThermo Thermodynamics package templated on the equation of state, using polynomial functions for cp, h and s C hPowerThermo Power-function based thermodynamics package templated on EquationOfState C hTabulatedThermo Enthalpy based thermodynamics package using non-uniform tabulated data for heat capacity vs temperature C janafThermo JANAF tables based thermodynamics package templated into the equation of state C sensibleEnthalpy Thermodynamics mapping class to expose the sensible enthalpy functions C sensibleInternalEnergy Thermodynamics mapping class to expose the sensible internal energy functions C constTransport Constant properties Transport package. Templated into a given thermodynamics package (needed for thermal conductivity) C logPolynomialTransport Transport package using polynomial functions of ln(T) for mu and kappa: C polynomialTransport Transport package using polynomial functions for mu and kappa C sutherlandTransport Transport package using Sutherland's formula C tabulatedTransport Transport properties package using non-uniform tabulated data for viscosity and thermal conductivity vs temperature C WLFTransport Transport package using the Williams-Landel-Ferry model C aC10H7CH3 AlphaMethylNaphthalene C Ar Liquid Ar C bC10H7CH3 BetaMethylNaphthalene C C10H22 NDecane C C12H26 NDodecane C C13H28 NTriDecane C C14H30 NTetraDecane C C16H34 NHexaDecane C C2H5OH Ethanol C C2H6 Ethane C C2H6O DiMethylEther C C3H6O Acetone C C3H8 Propane C C4H10O DiEthylEther C C6H14 NHexane C C6H6 Benzene C C7H16 NHeptane C C7H8 Toluene C C8H10 EthylBenzene C C8H18 NOctane C C9H20 NNonane C CH3OH Methanol C CH4N2O Urea, note that some of the properties are unavailable in the literature and have been copied from water C H2O Water C iC3H8O Iso-propanol C IC8H18 Iso-Octane C IDEA The IDEA fuel is constructed by adding 30% alphaMethylNaphthalene with 70% n-decane C liquid Generic thermophysical properties class for a liquid in which the functions and coefficients for each property are run-time selected C liquidMixtureProperties A mixture of liquids C liquidProperties The thermophysical properties of a liquid C MB Liquid nC3H7COOCH3 or (MB ) methyl butyrate (used for biodiesel surrogate) C N2 Liquid N2 C nC3H8O Propanol C ash Coal ash solid properties C C Graphite solid properties C CaCO3 Calcium carbonate (limestone) C solidMixtureProperties A mixture of solids C solidProperties The thermophysical, mechanical properties of a solid C APIdiffCoefFunc API function for vapour mass diffusivity C NSRDSfunc0 NSRDS function number 100 C NSRDSfunc1 NSRDS function number 101 C NSRDSfunc14 NSRDS function number 114 C NSRDSfunc2 NSRDS function number 102 C NSRDSfunc3 NSRDS function number 103 C NSRDSfunc4 NSRDS function number 104 C NSRDSfunc5 NSRDS function number 105 C NSRDSfunc6 NSRDS function number 106 C NSRDSfunc7 NSRDS-AICHE function number 107 C thermophysicalFunction Abstract base class for thermo-physical functions C thermophysicalProperties Base-class for thermophysical properties of solids, liquids and gases providing an interface compatible with the templated thermodynamics packages C thermophysicalPropertiesSelector Wrapper class providing run-time selection of thermophysicalProperties for the templated thermodynamics packages C externalWallHeatFluxTemperatureFvPatchScalarField This boundary condition applies a heat flux condition to temperature on an external wall in one of three modes: C humidityTemperatureCoupledMixedFvPatchScalarField C lumpedMassWallTemperatureFvPatchScalarField Employs a lumped mass model for temperature C outletMachNumberPressureFvPatchScalarField This boundary condition maintains a certain subsonic Mach number at an outlet patch by dynamically adjusting the static outlet pressure. It makes it possible, for example, to simulate the flow in a preturbine engine exhaust manifold, without resolving details of the flow inside the turbine. In general, the flow in a choked nozzle can be non-trivial and expensive to simulate C outletMappedUniformInletHeatAdditionFvPatchField This temperature boundary condition averages the temperature over the "outlet" patch specified by name "outletPatchName" and applies an extra heat source. This is set as a uniform temperature value on this patch. Additionally TMin/TMax limits can be applied C semiPermeableBaffleMassFractionFvPatchScalarField This is a mass-fraction boundary condition for a semi-permeable baffle C semiPermeableBaffleVelocityFvPatchVectorField This is a velocity boundary condition for a semi-permeable baffle C temperatureCoupledBase Common functions used in temperature coupled boundaries C totalFlowRateAdvectiveDiffusiveFvPatchScalarField This BC is used for species inlets. The diffusion and advection fluxes are considered to calculate the inlet value for the species The massFluxFraction sets the fraction of the flux of each particular species C sorptionWallFunctionFvPatchScalarField The sorptionWallFunction is a wall boundary condition to specify scalar/concentration gradient for turbulent and laminar flows C wallHeatTransferFvPatchScalarField This boundary condition provides an enthalpy condition for wall heat transfer C dynamicMotionSolverTopoFvMesh Sample topoChangerFvMesh that moves an object using a motion solver C linearValveFvMesh A sliding linear valve C linearValveLayersFvMesh A sliding linear valve with layers C mixerFvMesh A rotating slider mesh C movingConeTopoFvMesh Sample topoChangerFvMesh that moves an object in x direction and introduces/removes layers C rawTopoChangerFvMesh TopoChangerFvMesh without any added functionality C topoChangerFvMesh Abstract base class for a topology changing fvMesh C compressibleTransportModel Base-class for all transport models used by the compressible turbulence models C isoAdvection An implementation of the isoAdvector geometric Volume-of-Fluid method advancing the provided volume fraction field (alpha1) in time using the given velocity field, U, and corresponding face fluxes, phi C cutCell Service routines for cutting a cell, celli, of an fvMesh , mesh_, at its intersection with a surface C cutCellIso Class for cutting a cell, celli, of an fvMesh , mesh_, at its intersection with an isosurface defined by the mesh point values f_ and the cutValue, isoValue_ C cutCellPLIC Class for cutting a cell, cellI, of an fvMesh , mesh_, at its intersection with an surface defined by a normal and cutValue_ (defined as distance to the cell centre) C cutFace Base class for cutting a face, faceI, of an fvMesh , mesh_, at its intersections C cutFaceAdvect Calculates the face fluxes C cutFaceIso Class for cutting a face, faceI, of an fvMesh , mesh_, at its intersection with an isosurface defined by the mesh point values f_ and the isovalue, cutValue C cutFacePLIC Class for cutting a face, faceI, of an fvMesh , mesh_, at its intersection with an plane defined by normal and a base point C reconstructedDistanceFunction Calculates a reconstructed distance function C reconstructionSchemes Original code supplied by Henning Scheufler, DLR (2019) C interface C sampledInterface A sampledSurface that calculates the PLIC interface in VoF simulations Only works in combination with isoAdvector and a reconstruction scheme C surfaceIteratorIso Finds the isovalue that matches the volume fraction C surfaceIteratorPLIC Finds the cutValue that matches the volume fraction C immiscibleIncompressibleTwoPhaseMixture An immiscible incompressible two-phase mixture transport model C incompressibleTwoPhaseMixture A two-phase incompressible transportModel C singlePhaseTransportModel A simple single-phase transport model based on viscosityModel C transportModel Base-class for all transport models used by the incompressible turbulence models C viscosityModel An abstract base class for incompressible viscosityModels C alphaContactAngleTwoPhaseFvPatchScalarField Abstract base class for two-phase alphaContactAngle boundary conditions C interfaceCompressionLimiter Interface compression scheme currently based on the generic limited scheme although it does not use the NVD/TVD functions C interfaceProperties Contains the interface properties C surfaceTensionModel Abstract base-class for surface tension models which return the surface tension coefficient field C twoPhaseMixture A two-phase mixture model C constantAlphaContactAngleFvPatchScalarField A constant alphaContactAngle scalar boundary condition C dynamicAlphaContactAngleFvPatchScalarField A dynamic alphaContactAngle scalar boundary condition (alphaContactAngleTwoPhaseFvPatchScalarField ) C temperatureDependentAlphaContactAngleFvPatchScalarField Temperature-dependent alphaContactAngle scalar boundary condition C timeVaryingAlphaContactAngleFvPatchScalarField A time-varying alphaContactAngle scalar boundary condition (alphaContactAngleTwoPhaseFvPatchScalarField ) C alphaFixedPressureFvPatchScalarField A fixed-pressure alphaContactAngle boundary C compressibleTurbulenceModel Abstract base class for turbulence models (RAS, LES and laminar) C CompressibleTurbulenceModel Templated abstract base class for single-phase compressible turbulence models C EddyDiffusivity Templated abstract base class for single-phase compressible turbulence models C incompressibleRhoTurbulenceModel Abstract base class for turbulence models (RAS, LES and laminar) C incompressibleTurbulenceModel Abstract base class for turbulence models (RAS, LES and laminar) C IncompressibleTurbulenceModel Templated abstract base class for single-phase incompressible turbulence models C PhaseIncompressibleTurbulenceModel Templated abstract base class for multiphase incompressible turbulence models C DEShybrid Improved hybrid convection scheme of Travin et al. for hybrid RAS/LES calculations with enhanced Grey Area Mitigation (GAM) behaviour C kOmegaSSTBase Base class implementation of the k-omega-SST turbulence model for incompressible and compressible flows C SpalartAllmarasBase C fixedShearStressFvPatchVectorField This boundary condition sets a user-defined shear stress constant and uniform across a given patch by using the expression: C porousBafflePressureFvPatchField This boundary condition provides a jump condition, using the cyclic condition as a base C epsilonWallFunctionFvPatchScalarField This boundary condition provides wall functions for the turbulent kinetic energy dissipation rate (i.e. epsilon) and the turbulent kinetic energy production contribution (i.e. G) for low- and high-Reynolds number simulations C kLowReWallFunctionFvPatchScalarField This boundary condition provides a wall function for the turbulent kinetic energy (i.e. k) for low- and high-Reynolds number simulations C kqRWallFunctionFvPatchField This boundary condition provides a simple wrapper around the zero-gradient condition, which can be used for the turbulent kinetic energy (i.e. k), square-root of turbulent kinetic energy (i.e. q) and Reynolds stress symmetric-tensor fields (i.e. R) for the cases of high Reynolds number flow using wall functions. It is not a wall-function condition C nutkRoughWallFunctionFvPatchScalarField This boundary condition provides a wall-function for the turbulent viscosity (i.e. nut) when using wall functions for rough walls, based on the turbulent kinetic energy (i.e. k). The condition manipulates the wall roughness parameter (i.e. E) to account for roughness effects C nutkWallFunctionFvPatchScalarField This boundary condition provides a wall function for the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy, (i.e. k) for for low- and high-Reynolds number applications C nutLowReWallFunctionFvPatchScalarField This boundary condition provides a simple wrapper around a zero fixed-value condition for the turbulent viscosity (i.e. nut) for low-Reynolds number applications. It sets nut to zero, and provides an access function to calculate y+ C nutUBlendedWallFunctionFvPatchScalarField This boundary condition provides a wall function for the turbulent viscosity (i.e. nut) based on velocity (i.e. U) using a binomial-function wall-function blending method between the viscous and inertial sublayer predictions of nut for low- and high-Reynolds number applications C nutURoughWallFunctionFvPatchScalarField This boundary condition provides a wall function on the turbulent viscosity (i.e. nut) based on velocity (i.e. U) for low- and high-Reynolds number applications for rough walls C nutUSpaldingWallFunctionFvPatchScalarField This boundary condition provides a wall function for the turbulent viscosity (i.e. nut) based on velocity (i.e. U). Using Spalding's law gives a continuous nut profile to the wall C nutUTabulatedWallFunctionFvPatchScalarField This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on velocity (i.e. U), for low- and high-Reynolds number applications C nutUWallFunctionFvPatchScalarField This boundary condition provides a wall function for the turbulent viscosity (i.e. nut) based on velocity (i.e. U) for low- and high-Reynolds number applications C nutWallFunctionFvPatchScalarField The class nutWallFunction is an abstract base class that hosts nut wall-function boundary conditions C omegaWallFunctionFvPatchScalarField This boundary condition provides a wall function for the specific dissipation rate (i.e. omega) and the turbulent kinetic energy production contribution (i.e. G) for low- and high-Reynolds number applications C wallFunctionBlenders The class wallFunctionBlenders C wallFunctionCoefficients Class to host the wall-function coefficients being used in the wall function boundary conditions C DESModelBase Base class for DES models providing an interfaces to DES fields C eddyViscosity Eddy viscosity turbulence model base class C laminarModel Templated abstract base class for laminar transport models C LESdelta Abstract base class for LES deltas C is_contiguous< LESModels::smoothDelta::deltaData > Contiguous data for deltaData C anisotropicFilter Anisotropic filter C laplaceFilter Laplace filter for LES C LESfilter Abstract class for LES filters C simpleFilter Simple top-hat filter used in dynamic LES models C LESModel Templated abstract base class for LES SGS models C linearViscousStress Linear viscous stress turbulence model base class C nonlinearEddyViscosity Eddy viscosity turbulence model with non-linear correction base class C turbulentMixingLengthDissipationRateInletFvPatchScalarField This boundary condition provides an inlet condition for turbulent kinetic energy dissipation rate, i.e. epsilon, based on a specified mixing length. The patch values are calculated using: C turbulentMixingLengthFrequencyInletFvPatchScalarField This boundary condition provides a turbulence specific dissipation, C RASModelBase C RASModel Templated abstract base class for RAS turbulence models C ReynoldsStress Reynolds-stress turbulence model base class C turbulenceModel Abstract base class for turbulence models (RAS, LES and laminar) C TurbulenceModel Templated abstract base class for turbulence models C waveAlphaFvPatchScalarField Example of the boundary condition specification: C waveVelocityFvPatchVectorField Example of the boundary condition specification: C waveMakerPointPatchVectorField Point motion boundary condition to generate waves based on either piston or flap motions C waveModel Base class for waveModels C cellSplitter Does pyramidal decomposition of selected cells. So all faces will become base of pyramid with as top a user-supplied point (usually the cell centre) C edgeStats Helper class to calculate minimum edge length on mesh C hexBlock Hex block definition used in the cfx converter C fluentFvMesh C extrudedMesh C extrude2DMesh Given a 2D mesh insert all the topology changes to extrude. Does not work in parallel C patchToPoly2DMesh Convert a primitivePatch into a 2D polyMesh C cv2DControls Controls for the 2D CV mesh generator C backgroundMeshDecomposition Store a background polyMesh to use for the decomposition of space and queries for parallel conformalVoronoiMesh C cellAspectRatioControl C cellShapeControl C cellShapeControlMesh C cellSizeAndAlignmentControl C cellSizeAndAlignmentControls C fileControl C searchableSurfaceControl C controlMeshRefinement C smoothAlignmentSolver C cellSizeFunction Abstract base class for specifying target cell sizes C linearDistance C linearSpatial C surfaceOffsetLinearDistance C uniform C uniformDistance C automatic C cellSizeCalculationType Abstract base class for specifying target cell sizes C fieldFromFile C nonUniformField C surfaceCellSizeFunction Abstract base class for specifying target cell sizes C uniformValue C conformalVoronoiMesh C featurePointConformer The Delaunay vertices required to conform to a feature point can be determined upon initialisation because the feature points are fixed and do not change throughout the meshing process C pointFeatureEdgesTypes Hold the types of feature edges attached to the point C indexedCellEnum C is_contiguous< indexedCellEnum > Contiguous data for indexedCellEnum C indexedVertexEnum C is_contiguous< indexedVertexEnum > Contiguous data for indexedVertexEnum C conformationSurfaces C cvControls Controls for the conformalVoronoiMesh mesh generator C DelaunayMesh The vertex and cell classes must have an index defined C DistributedDelaunayMesh C faceAreaWeightModel Abstract base class for providing faceAreaWeight values to the cell motion controller based on an argument faceAreaFraction value, typically the ratio of the area of the face in question to the area of a square face with a side length of the local target cell size C piecewiseLinearRamp A linear ramp between 0 and 1 with definable start and end points C autoDensity Choose random points inside the domain and place them with a probability proportional to the target density of points C bodyCentredCubic Generate a BCC lattice of points inside the surfaces to be conformed to of the conformalVoronoiMesh C faceCentredCubic Generate an FCC lattice of points inside the surfaces to be conformed to of the conformalVoronoiMesh C initialPointsMethod Abstract base class for generating initial points for a conformalVoronoiMesh C pointFile Inserts points at locations specified in a pointFile into the surfaces to be conformed to of the conformalVoronoiMesh C rayShooting C uniformGrid Generate a uniform grid of points inside the surfaces to be conformed to of the conformalVoronoiMesh C pointPairs HashSet of unique edges. The edges are stored as a pair of pairs: C PrintTable Print a table in parallel, e.g.; C adaptiveLinear Produces a linear ramp which adapts its gradient to changes in endTime and deltaT to always arrive at the relaxationEnd value at the end of the run C rampHoldFall Piecewise linear function with a ramp from a start value to a plateaux value, holding at this, then a linear fall to an end value C relaxationModel Abstract base class for providing relaxation values to the cell motion controller C searchableBoxFeatures C searchablePlateFeatures C searchableSurfaceFeatures Decorator that returns the features of a searchable surface C triSurfaceMeshFeatures C CV2D Conformal-Voronoi 2D automatic mesher with grid or read initial points and point position relaxation with optional "squarification" C shortEdgeFilter2D This class filters short edges generated by the CV2D mesher C faceSelection Face selection method for createBaffles C mergePolyMesh Add a given mesh to the original mesh to create a single new mesh C mirrorFvMesh C meshDualiser Creates dual of polyMesh . Every point becomes a cell (or multiple cells for feature points), a walk around every edge creates faces between them C regionSide Determines the 'side' for every face and connected to a singly-connected (through edges) region of faces. Gets set of faces and a list of mesh edges ('fenceEdges') which should not be crossed. Used in splitting a mesh region C doxygenXmlParser Parser for doxygen XML C helpType Base class for foam help classes C domainDecomposition Automatic domain decomposition class for finite-volume meshes C domainDecompositionDryRun Testing of domain decomposition for finite-volume meshes C parFaFieldDistributorCache Simple container to manage read/write, redistribute finiteArea fields C parFvFieldDistributor Finite volume reconstructor for volume and surface fields C parLagrangianDistributor Lagrangian field redistributor C parPointFieldDistributor Distributor/redistributor for point fields, uses a two (or three) stage construction C unmappedPassivePositionParticleCloud PassivePositionParticleCloud but with autoMap and writing disabled. Only used for its objectRegistry to store lagrangian fields C foamToVtkReportFields Collection of simple static methods for reporting field names by category, which is used by foamToVTK C particleTracksSampler Helper class when generating particle tracks. The interface is fairly rudimentary C readFieldsHandler A simple field-loader, as per the readFields function object C ROMmodel Abstract base class for reduced-order models to handle specific model characteristics C channelIndex Does averaging of fields over layers of cells. Assumes layered mesh C boundaryInfo Class to interrogate the polyMesh/boundary file to provide mesh patching information, without the need to read the mesh C boundaryTemplates Class to store boundary template specifications C caseInfo Class to hold information related to the simaulation case C solverTemplate Class to store solver template specifications C PDRobstacle Obstacle definitions for PDR C PDRarrays Work array definitions for PDR fields C PDRmeshArrays OpenFOAM/PDRblock addressing information C PDRparams Parameters for PDRsetFields C PDRpatchDef Bookkeeping for patch definitions C implicitFunction Base class for implicit functions C PolyhedronReader C searchableSurfaceModifier Changing a surface C mixture C substance C PDRDragModel Base-class for sub-grid obstacle drag models. The available drag model is at basic.H C XiEqModel Base-class for all XiEq models used by the b-XiEq combustion model. The available models are : basicXiSubXiEq.H Gulder.H instabilityXiEq.H SCOPEBlendXiEq.H SCOPEXiEq.H C XiGModel Base-class for all Xi generation models used by the b-Xi combustion model. See Technical Report SH/RE/01R for details on the PDR modelling. For details on the use of XiGModel see XiModel.H . The model available is instabilityG.H C XiModel Base-class for all Xi models used by the b-Xi combustion model. See Technical Report SH/RE/01R for details on the PDR modelling C fixedRhoFvPatchScalarField Foam::fixedRhoFvPatchScalarField C smoluchowskiJumpTFvPatchScalarField Smoluchowski temperature jump boundary condition C maxwellSlipUFvPatchVectorField Maxwell slip boundary condition including thermal creep and surface curvature terms that can be optionally switched off C magnet Class to hold the defining data for a permanent magnet, in particular the name, relative permeability and remanence C DPMIncompressibleTurbulenceModel Templated abstract base class for volumen occupancy incompressible turbulence models C twoPhaseMixtureThermo C compressibleInterPhaseTransportModel Transport model selection class for the compressibleInterFoam family of solvers C alphaContactAngleFvPatchScalarField Contact-angle boundary condition for multi-phase interface-capturing simulations. Used in conjunction with multiphaseSystem C interfaceThetaProps C multiphaseMixtureThermo C interfacePair Symmetric pair of interface names C incompressibleTwoPhaseInteractingMixture A two-phase incompressible transportModel for interacting phases requiring the direct evaluation of the mixture viscosity, e.g. activated sludge or slurry C mixtureViscosityModel An abstract base class for incompressible mixtureViscosityModels C relativeVelocityModel C DTRMParticle Discrete Transfer Radiation Model (DTRM) particle C trackingData Class used to pass tracking data to the trackToFace function C iNew Factory class to read-construct particles (for parallel transfer) C temperaturePhaseChangeTwoPhaseMixture C thermoIncompressibleTwoPhaseMixture A two-phase incompressible transportModel C twoPhaseMixtureEThermo C immiscibleIncompressibleThreePhaseMixture An immiscible incompressible two-phase mixture transport model C incompressibleThreePhaseMixture C threePhaseInterfaceProperties Properties to aid interFoam : 1. Correct the alpha boundary condition for dynamic contact angle. 2. Calculate interface curvature C phaseChangeTwoPhaseMixture C multiphaseMixture Incompressible multi-phase mixture with built in solution for the phase fractions with interface compression for interface-capturing C interfacePair Symmetric pair of interface names C phase Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations C iNew Return a pointer to a new phase created on freestore C tractionDisplacementFvPatchVectorField Fixed traction boundary condition for the standard linear elastic, fixed coefficient displacement equation C tractionDisplacementCorrectionFvPatchVectorField N stdFoam Namespace for std templates that are are part of future C++ standards or that are in a state of change C span Rudimentary functionality similar to std::span for holding memory view C absorptionCoeffs Absorption coefficients class used in greyMeanAbsorptionEmission and wideBandAbsorptionEmission C areaFields Finite area area (element) fields C AssemblyPvPatch An assembly of lduMatrix that is specific inter-region coupling through mapped patches C autoPatch Patchify triangles based on a feature angle. Replacement of surfaceAutoPatch C basicHeterogeneousReactingCloud Cloud class to introduce heterogeneou reacting parcels C basicHeterogeneousReactingParcel Definition of reacting heterogeneous parcel C basicKinematicCloud Cloud class to introduce kinematic parcels C basicKinematicCollidingCloud Cloud class to introduce kinematic colliding parcels C basicKinematicCollidingParcel Definition of basic kinematic colliding parcel C basicKinematicMPPICCloud Cloud class to introduce kinematic MPPIC parcels C basicKinematicMPPICParcel Definition of basic kinematic MPPIC parcel C basicKinematicParcel Definition of basic kinematic parcel C basicReactingCloud Cloud class to introduce reacting parcels C basicReactingMultiphaseCloud Cloud class to introduce multi-phase reacting parcels C basicReactingMultiphaseParcel Definition of basic reacting parcel C basicReactingParcel Definition of basic reacting parcel C basicSprayCloud Cloud class to introduce reacting spray parcels C basicSprayParcel Definition of spray parcel C basicThermoCloud Cloud class to introduce thermodynamic parcels C basicThermoParcel Definition of basic thermo parcel C boundaryRadiationPropertiesPatch C boundedBackwardFaDdtScheme Second-order backward-differencing implicit ddt using the current and two previous time-step values C CentredFitSnGradScheme Centred fit snGrad scheme which applies an explicit correction to snGrad C CHFSubCoolModel Base class for critical heat flux (CHF) sub-cooling correlation models for boiling flows C coalCloud Cloud class to introduce coal parcels C coalParcel Definition of coal parcel C codedSource Constructs on-the-fly fvOption source C compositeBody This specialized rigidBody holds the original body after it has been merged into a parent C constant Constant condensation/saturation model C constantSurfaceTensionCoefficient Constant value surface tension model C constrainHbyA C constrainPressure C consumptionSpeed Correlation function for laminar consumption speed obtained from flamelet solution at increasing strain rates C CorrectPhi Flux correction functions to ensure continuity C cubeRootVolDelta Simple cube-root of cell volume delta used in LES models C cuboid Specialization of rigidBody to construct a cuboid given the mass and lengths of the sides C cut Patchify triangles based on orientation w.r.t other (triangulated or triangulatable) surfaces C DdtScheme Abstract base class for finite volume calculus ddt schemes C doubleTensor A Tensor of values with double precision C doubleVector A Vector of values with double precision C doubleVector2D A Vector2D of values with double precision C dsmcCloud Cloud class to simulate dsmc parcels C edgeFields Finite area edge fields C electrostaticPotential C ensightCoordSetWriter A coordSetWriter for Ensight format C equipotentialPointSmoother Equipotential point smoothing. Points are moved towards the centroid of the surrounding cell volumes. This method tends to equilise cell volumes, and can generate distorted cells around refinement patterns C EulerDdtScheme Basic first-order Euler implicit/explicit ddt using only the current and previous time-step values C eulerianParticle Lightweight class to store particle data derived from VOF calculations, with special handling for input, output and parallel reduction C externalCoupledTemperatureMixedFvPatchScalarField C externalCoupledTemperatureMixedFvPatchScalarField This boundary condition provides a temperatue interface to an external application C faScalarMatrix Template specialisation for scalar faMatrix C FieldAssociation The field association for mesh (patch/volume) values C fieldRegularisation Regularises the given field using a PDE smoother and then sharpens (projects) the result using a smoothed Heaviside function. Used in topology optimisation to regularise the designed geometries and obtain 'grid independent' solutions C fieldsDistributor Common methods/utilities for field decomposers/distributors etc C fileOperationInitialise General fileOperation initialiser. Handles -ioRanks option, using it to set the FOAM_IORANKS environment variable C filmBoilingModel Base class for film boiling models C floatTensor A Tensor of values with float precision C floatVector A Vector of values with float precision C floatVector2D A Vector2D of values with float precision C GaussLaplacianScheme Variant of GaussLaplacian that avoids intermediate fields C general General relative velocity model C heheuReactionThermo Foam::heheuReactionThermo C helpBoundary This class provides help for boundary conditions (patch fields). When no additional arguments are given, the utility outputs all known boundary conditions C helpFunctionObject This class provides help for functionObjects. When no additional arguments are given, the utility outputs all known function objects C helpSolver This class provides help for solvers. When no additional arguments are given, the utility outputs all known solvers C humidityTemperatureCoupledMixedFvPatchScalarField Mixed boundary condition for temperature to be used at the coupling interface between fluid solid regions C hyperbolic C IDDESDelta IDDESDelta used by the IDDES (improved low Re Spalart-Allmaras DES model) The min and max delta are calculated using the face to face distance of the cell C IndexedFace C interfaceHeatResistance Interface Heat Resistance type of condensation/saturation model using spread source distribution following: C istream C Jeschar A model for minimum heat flux based on Jeschar et al. (1992) for boiling flows C jointBody C kinematicParcelInjectionDataIOList C kineticTheoryModel Kinetic theory particle phase RAS model C laplacianConstraintPointSmoother Laplacian point smoothing. Points are moved towards the average of the surrounding points. In case of constraints (boundary points) only use average of equal or higher constrained points C laplacianPointSmoother Laplacian point smoothing (or rather Lloyds). Points are moved towards the average of the surrounding cell centres (or average of boundary face centres for points on boundary) C LimitFuncs Class to create NVD/TVD limited weighting-factors C linearTsub Vapour bubble diameter model for modelling of condensation of vapour bubbles. Calculates bubble diameter as a function of liquid phase subcooling C liquidFilmBase Base class for liquid-film models C liquidFilmModel Thin film model C Lun C MapFaAreaField Map area internal field on topology change. This is a partial template specialisation, see MapGeometricFields C MapFaEdgeField Map edge internal field on topology change. This is a partial template specialisation, see MapGeometricFields C MapPointField Map point field on topology change. This is a partial template specialisation for GeoMesh=pointMesh C marchingCells Marches cells from given seed patches, faceZones or the boundary faces of cellZones, towards the interior of the mesh, with a given step at a time. Used in topology optimisation, to gradually activate the design variables, in an attempt to prevent the optimiser from acting too agressively in the first optimisation cycles. Use meshWave to do the marching C MarshakRadiationFixedTemperatureFvPatchScalarField A 'mixed' boundary condition that implements a Marshak condition for the incident radiation field (usually written as G) C MarshakRadiationFvPatchScalarField A 'mixed' boundary condition that implements a Marshak condition for the incident radiation field (usually written as G) C masslessBody C maxDeltaxyz Delta calculated by taking the maximum distance between the cell centre and any face centre. For a regular hex cell, the computed delta will equate to half of the cell width; accordingly, the deltaCoeff model coefficient should be set to 2 for this case C maxDeltaxyzCubeRootLESDelta Maximum delta between maxDeltaxyz and cubeRootVolDelta C MHFModel Base class for minimum heat flux (MHF) models C minMaxCondition Minimum/maximum run time conditions. If the value type is not scalar, the magnitude of the value is used in the evaluation C My_items C Face_wrapper C noBlending C noneCondition A no-op condition that simply returns true/nothing to do C noneViscosity C NoPacking Place holder for the 'none' option C OSCountStream An output stream for calculating byte counts C ostream C PatchInjectionBase Base class for patch-based injection models C phasePressureModel Particle-particle phase-pressure RAS model C pointConversion Conversion functions between point (Foam ::) and Point (CGAL ::) C PolynomialEntry PolynomialEntry container data entry for scalars. Items are stored in a list of Tuple2's. Data is input in the form, e.g. for an entry <entryName> that describes y = x^2 + 2x^3 C PrandtlDelta Apply Prandtl mixing-length based damping function to the specified geometric delta to improve near-wall behavior or LES models C reactingMultiphaseParcelInjectionDataIOList C reactingParcelInjectionDataIOList C rigidBodyInertia This class represents the linear and angular inertia of a rigid body by the mass, centre of mass and moment of inertia tensor about the centre of mass C runTimeControl Controls when the calculation is terminated based on satisfying user-specified conditions C sample Minimal example by using system/controlDict.functions: C scalarMatrices Scalar matrices C shallowWaterAbsorption C simplifiedDynamicFvMesh Functions to generate simplified finite volume meshes C SinclairJackson C smoothDelta Smoothed delta which takes a given simple geometric delta and applies smoothing to it such that the ratio of deltas between two cells is no larger than a specified amount, typically 1.15 C SpalartAllmarasBase Base class to handle various characteristics for SpalartAllmaras based LES/DES turbulence models for incompressible and compressible flows C sphere Specialization of rigidBody to construct a sphere given the mass and radius C steadyStateDdtScheme SteadyState implicit/explicit ddt which returns 0 C subBody This specialized rigidBody holds the original body after it has been merged into a master C surfactantProperties C surfFields Fields for surfMesh C SyamlalRogersOBrien C tensor Tensor of scalars, i.e. Tensor<scalar> C thermalShell Thermal-shell finite-area model. It solves the energy equation in 2D. The coupling with the 3D region is done through the temperatureCoupledBase, plus faOption is available to add extra sources on the shell such as externalHeatFluxSource etc C thermo Basic thermodynamics type based on the use of fitting functions for cp, h, s obtained from the template argument type thermo. All other properties are derived from these primitive functions C thermoParcelInjectionDataIOList C TomiyamaSwarm Swarm correction of Tomiyama et al C topOInterpolationFunction Abstract base class for interpolation functions used in topology optimisation C topOZones Class holding cells zones used in topology optimisation C transferModelList List container for film transfer models C treeDataTriSurface Encapsulates data for (indexedOc)tree searches on a triSurface C triSurfaceSTLCore C updateableSnGrad Helper class to fix pressure flux for pressure-related boundary conditions C VakhrushevEfremov Aspect ratio model of Vakhrushev and Efremov C vanDriestDelta Simple cube-root of cell volume delta used in incompressible LES models C vector A Vector of values with scalar precision, where scalar is float/double depending on the compilation flags C vectorTools Functions for analysing the relationships between vectors C velocityFilmShellFvPatchVectorField This boundary condition provides a coupled velocity condition between a primary region (3D mesh) and a liquid-film model (2D mesh) C vibrationShellFvPatchScalarField This boundary condition provides a coupled acoustic pressure condition between a primary region (3D mesh) and a vibration shell model (2D mesh) C waveAbsorptionModel C waveGenerationModel C waxSolventEvaporation Wax solvent mixture evaporation model C zoneSubSet Intermediate tool for handling cellZones for function objects (e.g. momentumError) wherein the sub-mesh option is available
![$[s^{-2}]$](form_323_dark.png)
1.16.1 