swarmCorrection.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2014-2018 OpenFOAM Foundation
9  Copyright (C) 2019-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "swarmCorrection.H"
30 #include "phasePair.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36  defineTypeNameAndDebug(swarmCorrection, 0);
37  defineRunTimeSelectionTable(swarmCorrection, dictionary);
38 }
39 
40 
41 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42 
44 (
45  const dictionary& dict,
46  const phasePair& pair
47 )
48 :
49  pair_(pair)
50 {}
51 
52 
53 // * * * * * * * * * * * * * * * * Selector * * * * * * * * * * * * * * * * //
54 
57 (
58  const dictionary& dict,
59  const phasePair& pair
60 )
61 {
62  const word modelType(dict.get<word>("type"));
63 
64  Info<< "Selecting swarmCorrection for "
65  << pair << ": " << modelType << endl;
66 
67  auto* ctorPtr = dictionaryConstructorTable(modelType);
68 
69  if (!ctorPtr)
70  {
72  (
73  dict,
74  "swarmCorrection",
75  modelType,
76  *dictionaryConstructorTablePtr_
77  ) << abort(FatalIOError);
78  }
79 
80  return ctorPtr(dict, pair);
81 }
82 
83 
84 // ************************************************************************* //
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:53
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::swarmCorrection::swarmCorrection
swarmCorrection(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
Definition: swarmCorrection.C:44
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::swarmCorrection::New
static autoPtr< swarmCorrection > New(const dictionary &dict, const phasePair &pair)
Definition: swarmCorrection.C:57
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::autoPtr< Foam::swarmCorrection >
swarmCorrection.H
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)