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-------------------------------------------------------------------------------
10License
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
33namespace Foam
34{
35namespace tetherPotentials
36{
37
38// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39
41
43(
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{
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// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
virtual bool read()
Re-read model coefficients if they have changed.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const dictionary & subDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary.
Definition: dictionary.C:460
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
Base class for film (stress-based) force models.
Definition: force.H:59
const dictionary & tetherPotentialProperties() const
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
Namespace for OpenFOAM.
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
dimensioned< typename typeOfMag< Type >::type > magSqr(const dimensioned< Type > &dt)