| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2012-2026 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::codedFvModel | |
| Description | |
| Constructs on-the-fly fvModel source from user-supplied code | |
| Usage | |
| Example usage in constant/fvModels: | |
| \verbatim | |
| energySource | |
| { | |
| type coded; | |
| cellZone all; | |
| field h; | |
| codeInclude | |
| #{ | |
| #}; | |
| codeAddSup | |
| #{ | |
| Pout<< "**codeAddSup**" << endl; | |
| const Time& time = mesh().time(); | |
| const scalarField& V = mesh().V(); | |
| scalarField& heSource = eqn.source(); | |
| heSource -= 0.1*sqr(time.value())*V; | |
| #}; | |
| codeAddRhoSup | |
| #{ | |
| Pout<< "**codeAddRhoSup**" << endl; | |
| #}; | |
| codeAddAlphaRhoSup | |
| #{ | |
| Pout<< "**codeAddAlphaRhoSup**" << endl; | |
| #}; | |
| } | |
| \endverbatim | |
| SourceFiles | |
| codedFvModel.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace fv | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class codedFvModel Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class codedFvModel | |
| : | |
| public fvModel, | |
| public codedBase | |
| { | |
| // Private data | |
| //- Keywords associated with source code | |
| static const wordList codeKeys; | |
| //- Name of the dictionary variables in the source code | |
| static const wordList codeDictVars; | |
| // Name of the code options template file | |
| static const word codeOptions; | |
| // Names of the source files to compile | |
| static const wordList compileFiles; | |
| // Names of the source files to copy (header files) | |
| static const wordList copyFiles; | |
| //- The name of the field that this fvModel applies to | |
| word fieldName_; | |
| //- Cached coefficients dictionary | |
| // Required for the delayed | |
| dictionary coeffsDict_; | |
| //- Underlying functionObject | |
| mutable autoPtr<fvModel> redirectFvModelPtr_; | |
| // Private Member Functions | |
| //- Non-virtual read | |
| void readCoeffs(const dictionary& dict); | |
| //- Return the name of the field's primitive type | |
| word fieldPrimitiveTypeName() const; | |
| //- Compile, link and load the coded fvModel if not already loaded | |
| // and return it | |
| fvModel& redirectFvModel() const; | |
| // Sources | |
| //- Add a source term to an equation | |
| template<class Type> | |
| void addSupType | |
| ( | |
| const VolField<Type>& field, | |
| fvMatrix<Type>& eqn | |
| ) const; | |
| //- Add a source term to a compressible equation | |
| template<class Type> | |
| void addSupType | |
| ( | |
| const volScalarField& rho, | |
| const VolField<Type>& field, | |
| fvMatrix<Type>& eqn | |
| ) const; | |
| //- Add a source term to a phase equation | |
| template<class Type> | |
| void addSupType | |
| ( | |
| const volScalarField& alpha, | |
| const volScalarField& rho, | |
| const VolField<Type>& field, | |
| fvMatrix<Type>& eqn | |
| ) const; | |
| public: | |
| //- Runtime type information | |
| TypeName("coded"); | |
| // Constructors | |
| //- Construct from components | |
| codedFvModel | |
| ( | |
| const word& name, | |
| const word& modelType, | |
| const fvMesh& mesh, | |
| const dictionary& dict | |
| ); | |
| // Member Functions | |
| // Checks | |
| //- Return the list of fields for which the fvModel adds source term | |
| // to the transport equation | |
| virtual wordList addSupFields() const; | |
| // Sources | |
| //- Add a source term to an equation | |
| FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_FIELD_SUP) | |
| //- Add a source term to a compressible equation | |
| FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_RHO_FIELD_SUP) | |
| //- Add a source term to a phase equation | |
| FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_ALPHA_RHO_FIELD_SUP) | |
| // Mesh changes | |
| //- 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&); | |
| // IO | |
| //- Read source dictionary | |
| virtual bool read(const dictionary& dict); | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace fv | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |