tractionDisplacementCorrectionFvPatchVectorField.H
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 #ifndef tractionDisplacementCorrectionFvPatchVectorField_H
29 #define tractionDisplacementCorrectionFvPatchVectorField_H
30 
31 #include "fvPatchFields.H"
33 
34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 
39 /*---------------------------------------------------------------------------*\
40  Class tractionDisplacementCorrectionStressFvPatch Declaration
41 \*---------------------------------------------------------------------------*/
42 
44 :
45  public fixedGradientFvPatchVectorField
46 {
47 
48  // Private Data
49 
50  vectorField traction_;
51  scalarField pressure_;
52 
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("tractionDisplacement");
58 
59 
60  // Constructors
61 
62  //- Construct from patch and internal field
64  (
65  const fvPatch&,
67  );
68 
69  //- Construct from patch, internal field and Istream
71  (
72  const fvPatch&,
74  Istream&
75  );
76 
77  //- Construct from patch, internal field and dictionary
79  (
80  const fvPatch&,
82  const dictionary&
83  );
84 
85  //- Construct by mapping given
86  // tractionDisplacementCorrectionFvPatchVectorField onto a new patch
88  (
90  const fvPatch&,
92  const fvPatchFieldMapper&
93  );
94 
95  //- Construct as copy setting internal field reference
97  (
99  );
100 
101  //- Construct and return a clone
103  {
105  (
107  );
108  }
109 
110  //- Construct as copy setting internal field reference
112  (
115  );
116 
117  //- Construct and return a clone setting internal field reference
119  (
121  ) const
122  {
124  (
126  );
127  }
128 
129 
130  // Member functions
131 
132  // Access
133 
134  virtual const vectorField& traction() const
135  {
136  return traction_;
137  }
138 
140  {
141  return traction_;
142  }
143 
144  virtual const scalarField& pressure() const
145  {
146  return pressure_;
147  }
148 
150  {
151  return pressure_;
152  }
153 
154 
155  // Mapping functions
156 
157  //- Map (and resize as needed) from self given a mapping object
158  virtual void autoMap
159  (
160  const fvPatchFieldMapper&
161  );
162 
163  //- Reverse map the given fvPatchField onto this fvPatchField
164  virtual void rmap
165  (
166  const fvPatchVectorField&,
167  const labelList&
168  );
169 
170 
171  //- Update the coefficients associated with the patch field
172  virtual void updateCoeffs();
173 
174  //- Write
175  virtual void write(Ostream&) const;
176 };
177 
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 } // End namespace Foam
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 #endif
186 
187 // ************************************************************************* //
Foam::fvPatchField< vector >
Foam::tractionDisplacementCorrectionFvPatchVectorField::pressure
virtual scalarField & pressure()
Definition: tractionDisplacementCorrectionFvPatchVectorField.H:149
Foam::tractionDisplacementCorrectionFvPatchVectorField::rmap
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Foam::tractionDisplacementCorrectionFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::tractionDisplacementCorrectionFvPatchVectorField::traction
virtual const vectorField & traction() const
Definition: tractionDisplacementCorrectionFvPatchVectorField.H:134
Foam::tractionDisplacementCorrectionFvPatchVectorField::TypeName
TypeName("tractionDisplacement")
Runtime type information.
Foam::tractionDisplacementCorrectionFvPatchVectorField
Definition: tractionDisplacementCorrectionFvPatchVectorField.H:43
Foam::tractionDisplacementCorrectionFvPatchVectorField::pressure
virtual const scalarField & pressure() const
Definition: tractionDisplacementCorrectionFvPatchVectorField.H:144
Foam::Field< vector >
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::tractionDisplacementCorrectionFvPatchVectorField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::tractionDisplacementCorrectionFvPatchVectorField::traction
virtual vectorField & traction()
Definition: tractionDisplacementCorrectionFvPatchVectorField.H:139
fixedGradientFvPatchFields.H
fvPatchFields.H
Foam::List< label >
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::tractionDisplacementCorrectionFvPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::tractionDisplacementCorrectionFvPatchVectorField::clone
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
Definition: tractionDisplacementCorrectionFvPatchVectorField.H:102
Foam::tractionDisplacementCorrectionFvPatchVectorField::tractionDisplacementCorrectionFvPatchVectorField
tractionDisplacementCorrectionFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54