tetherPotential.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) 2011 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "tetherPotential.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34  defineTypeNameAndDebug(tetherPotential, 0);
35  defineRunTimeSelectionTable(tetherPotential, dictionary);
36 }
37 
38 
39 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40 
42 (
43  const word& name,
44  const dictionary& tetherPotentialProperties
45 )
46 :
47  name_(name),
48  tetherPotentialProperties_(tetherPotentialProperties)
49 {}
50 
51 
52 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
53 
54 
55 bool Foam::tetherPotential::read(const dictionary& tetherPotentialProperties)
56 {
58 
59  return true;
60 }
61 
62 
63 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
tetherPotential.H
Foam::tetherPotential::tetherPotentialProperties_
dictionary tetherPotentialProperties_
Definition: tetherPotential.H:63
Foam::tetherPotential::read
virtual bool read(const dictionary &tetherPotentialProperties)=0
Read tetherPotential dictionary.
Definition: tetherPotential.C:55
Foam::tetherPotential::tetherPotential
tetherPotential(const tetherPotential &)=delete
No copy construct.
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::tetherPotential::tetherPotentialProperties
const dictionary & tetherPotentialProperties() const
Definition: tetherPotential.H:126
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)