restrainedHarmonicSpring.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 
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace tetherPotentials
36 {
37 
38 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39 
40 defineTypeNameAndDebug(restrainedHarmonicSpring, 0);
41 
43 (
44  tetherPotential,
45  restrainedHarmonicSpring,
46  dictionary
47 );
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
53 (
54  const word& name,
55  const dictionary& tetherPotentialProperties
56 )
57 :
58  tetherPotential(name, tetherPotentialProperties),
59  restrainedHarmonicSpringCoeffs_
60  (
61  tetherPotentialProperties.subDict(typeName + "Coeffs")
62  ),
63  springConstant_
64  (
65  restrainedHarmonicSpringCoeffs_.get<scalar>("springConstant")
66  ),
67  rR_
68  (
69  restrainedHarmonicSpringCoeffs_.get<scalar>("rR")
70  )
71 {}
72 
73 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
74 
76 {
77  scalar magR = mag(r);
78 
79  if (magR < rR_)
80  {
81  return 0.5 * springConstant_ * magSqr(r);
82  }
83  else
84  {
85  return 0.5 * springConstant_ * rR_ * rR_
86  + springConstant_ * rR_ * (magR - rR_);
87  }
88 }
89 
90 
92 {
93  scalar magR = mag(r);
94 
95  if (magR < rR_)
96  {
97  return -springConstant_ * r;
98  }
99  else
100  {
101  return -springConstant_ * rR_ * r / magR;
102  }
103 }
104 
105 
107 (
108  const dictionary& tetherPotentialProperties
109 )
110 {
111  tetherPotential::read(tetherPotentialProperties);
112 
113  restrainedHarmonicSpringCoeffs_ =
114  tetherPotentialProperties.subDict(typeName + "Coeffs");
115 
116  restrainedHarmonicSpringCoeffs_.readEntry("springConstant", springConstant_);
117  restrainedHarmonicSpringCoeffs_.readEntry("rR", rR_);
118 
119  return true;
120 }
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace tetherPotentials
126 } // End namespace Foam
127 
128 // ************************************************************************* //
Foam::tetherPotential
Definition: tetherPotential.H:55
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::tetherPotentials::restrainedHarmonicSpring::energy
scalar energy(const vector r) const
Definition: restrainedHarmonicSpring.C:75
Foam::tetherPotentials::restrainedHarmonicSpring::force
vector force(const vector r) const
Definition: restrainedHarmonicSpring.C:91
Foam::tetherPotentials::restrainedHarmonicSpring::restrainedHarmonicSpring
restrainedHarmonicSpring(const word &name, const dictionary &tetherPotentialProperties)
Construct from components.
Definition: restrainedHarmonicSpring.C:53
restrainedHarmonicSpring.H
Foam::magSqr
dimensioned< typename typeOfMag< Type >::type > magSqr(const dimensioned< Type > &dt)
Foam::tetherPotential::read
virtual bool read(const dictionary &tetherPotentialProperties)=0
Read tetherPotential dictionary.
Definition: tetherPotential.C:55
Foam::dictionary::subDict
const dictionary & subDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary.
Definition: dictionary.C:460
Foam::dictionary::readEntry
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
Definition: dictionaryTemplates.C:302
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::tetherPotentials::restrainedHarmonicSpring::read
bool read(const dictionary &tetherPotentialProperties)
Read dictionary.
Definition: restrainedHarmonicSpring.C:107
Foam::tetherPotentials::defineTypeNameAndDebug
defineTypeNameAndDebug(harmonicSpring, 0)
Foam::Vector< scalar >
Foam::mag
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
Foam::tetherPotentials::addToRunTimeSelectionTable
addToRunTimeSelectionTable(tetherPotential, harmonicSpring, dictionary)
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59