restrainedHarmonicSpring.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 
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  restrainedHarmonicSpringCoeffs_
58  (
59  tetherPotentialProperties.subDict(typeName + "Coeffs")
60  ),
61  springConstant_
62  (
63  restrainedHarmonicSpringCoeffs_.template lookup<scalar>
64  (
65  "springConstant"
66  )
67  ),
68  rR_
69  (
70  restrainedHarmonicSpringCoeffs_.template lookup<scalar>
71  (
72  "rR"
73  )
74  )
75 {}
76 
77 
78 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
79 
81 {
82  scalar magR = mag(r);
83 
84  if (magR < rR_)
85  {
86  return 0.5 * springConstant_ * magSqr(r);
87  }
88  else
89  {
90  return 0.5 * springConstant_ * rR_ * rR_
91  + springConstant_ * rR_ * (magR - rR_);
92  }
93 }
94 
95 
97 {
98  scalar magR = mag(r);
99 
100  if (magR < rR_)
101  {
102  return -springConstant_ * r;
103  }
104  else
105  {
106  return -springConstant_ * rR_ * r / magR;
107  }
108 }
109 
110 
112 (
113  const dictionary& tetherPotentialProperties
114 )
115 {
117 
118  restrainedHarmonicSpringCoeffs_ =
119  tetherPotentialProperties.subDict(typeName + "Coeffs");
120 
121  restrainedHarmonicSpringCoeffs_.lookup("springConstant") >> springConstant_;
122  restrainedHarmonicSpringCoeffs_.lookup("rR") >> rR_;
123 
124  return true;
125 }
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace tetherPotentials
131 } // End namespace Foam
132 
133 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:860
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:998
virtual bool read(const dictionary &tetherPotentialProperties)=0
Read tetherPotential dictionary.
const dictionary & tetherPotentialProperties() const
bool read(const dictionary &tetherPotentialProperties)
Read dictionary.
restrainedHarmonicSpring(const word &name, const dictionary &tetherPotentialProperties)
Construct from components.
A class for handling words, derived from string.
Definition: word.H:62
defineTypeNameAndDebug(harmonicSpring, 0)
addToRunTimeSelectionTable(tetherPotential, harmonicSpring, dictionary)
Namespace for OpenFOAM.
dimensioned< scalar > mag(const dimensioned< Type > &)
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
dimensioned< scalar > magSqr(const dimensioned< Type > &)