harmonicSpring.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "harmonicSpring.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace tetherPotentials
34 {
35 
36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
37 
39 
41 (
45 );
46 
47 
48 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
49 
51 (
52  const word& name,
53  const dictionary& tetherPotentialProperties
54 )
55 :
56  tetherPotential(name, tetherPotentialProperties),
57  harmonicSpringCoeffs_
58  (
59  tetherPotentialProperties.subDict(typeName + "Coeffs")
60  ),
61  springConstant_
62  (
63  harmonicSpringCoeffs_.template lookup<scalar>("springConstant")
64  )
65 {}
66 
67 
68 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
69 
70 scalar harmonicSpring::energy(const vector r) const
71 {
72  return 0.5*springConstant_*magSqr(r);
73 }
74 
75 
77 {
78  return -springConstant_*r;
79 }
80 
81 
82 bool harmonicSpring::read(const dictionary& tetherPotentialProperties)
83 {
84  tetherPotential::read(tetherPotentialProperties);
85 
86  harmonicSpringCoeffs_ =
87  tetherPotentialProperties.subDict(typeName + "Coeffs");
88 
89  harmonicSpringCoeffs_.lookup("springConstant") >> springConstant_;
90 
91  return true;
92 }
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace tetherPotentials
98 } // End namespace Foam
99 
100 // ************************************************************************* //
scalar energy(const vector r) const
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Macros for easy insertion into run-time selection tables.
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:982
bool read(const dictionary &tetherPotentialProperties)
Read dictionary.
virtual bool read(const dictionary &tetherPotentialProperties)=0
Read tetherPotential dictionary.
A class for handling words, derived from string.
Definition: word.H:59
defineTypeNameAndDebug(harmonicSpring, 0)
dimensioned< scalar > magSqr(const dimensioned< Type > &)
vector force(const vector r) const
addToRunTimeSelectionTable(tetherPotential, harmonicSpring, dictionary)
harmonicSpring(const word &name, const dictionary &tetherPotentialProperties)
Construct from components.
Namespace for OpenFOAM.
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:844