| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2023-2024 OpenFOAM Foundation | |
| \\/ M anipulation | | |
| ------------------------------------------------------------------------------- | |
| License | |
| This file is part of OpenFOAM. | |
| OpenFOAM is free software: you can redistribute it and/or modify it | |
| under the terms of the GNU General Public License as published by | |
| the Free Software Foundation, either version 3 of the License, or | |
| (at your option) any later version. | |
| OpenFOAM is distributed in the hope that it will be useful, but WITHOUT | |
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| for more details. | |
| You should have received a copy of the GNU General Public License | |
| along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. | |
| Class | |
| Foam::fv::bound | |
| Description | |
| Bound the specified scalar field where it is below the specified minimum. | |
| Where the field is unbounded it is set to the maximum of the average of | |
| the neighbouring cell values and the specified minimum. | |
| Usage | |
| Example usage: | |
| \verbatim | |
| limitp | |
| { | |
| type bound; | |
| field p; | |
| min 100; | |
| } | |
| \endverbatim | |
| SourceFiles | |
| bound.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace fv | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class bound Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class bound | |
| : | |
| public fvConstraint | |
| { | |
| // Private data | |
| //- Field name | |
| word fieldName_; | |
| //- Minimum value | |
| scalar min_; | |
| // Private Member Functions | |
| //- Non-virtual read | |
| void readCoeffs(const dictionary& dict); | |
| public: | |
| //- Runtime type information | |
| TypeName("bound"); | |
| // Constructors | |
| //- Construct from components | |
| bound | |
| ( | |
| const word& name, | |
| const word& modelType, | |
| const fvMesh& mesh, | |
| const dictionary& dict | |
| ); | |
| //- Disallow default bitwise copy construction | |
| bound(const bound&) = delete; | |
| //- Destructor | |
| virtual ~bound() | |
| {} | |
| // Member Functions | |
| //- Return the list of fields constrained by the fvConstraint | |
| virtual wordList constrainedFields() const; | |
| //- Constrain the pressure field | |
| virtual bool constrain(volScalarField& p) const; | |
| //- Update for mesh motion | |
| virtual bool movePoints(); | |
| //- Update topology using the given map | |
| virtual void topoChange(const polyTopoChangeMap&); | |
| //- Update from another mesh using the given map | |
| virtual void mapMesh(const polyMeshMap&); | |
| //- Redistribute or update using the given distribution map | |
| virtual void distribute(const polyDistributionMap&); | |
| //- Read dictionary | |
| virtual bool read(const dictionary& dict); | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const bound&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace fv | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |