tractionDisplacementCorrectionFvPatchVectorField.H
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-2022 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 #ifndef tractionDisplacementCorrectionFvPatchVectorField_H
27 #define tractionDisplacementCorrectionFvPatchVectorField_H
28 
29 #include "fvPatchFields.H"
31 
32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 
37 /*---------------------------------------------------------------------------*\
38  Class tractionDisplacementCorrectionStressFvPatch Declaration
39 \*---------------------------------------------------------------------------*/
40 
42 :
43  public fixedGradientFvPatchVectorField
44 {
45 
46  // Private Data
47 
48  vectorField traction_;
49  scalarField pressure_;
50 
51 
52 public:
53 
54  //- Runtime type information
55  TypeName("tractionDisplacement");
56 
57 
58  // Constructors
59 
60  //- Construct from patch and internal field
62  (
63  const fvPatch&,
65  );
66 
67  //- Construct from patch, internal field and Istream
69  (
70  const fvPatch&,
72  Istream&
73  );
74 
75  //- Construct from patch, internal field and dictionary
77  (
78  const fvPatch&,
80  const dictionary&
81  );
82 
83  //- Construct by mapping given
84  // tractionDisplacementCorrectionFvPatchVectorField onto a new patch
86  (
88  const fvPatch&,
90  const fvPatchFieldMapper&
91  );
92 
93  //- Disallow copy without setting internal field reference
95  (
97  ) = delete;
98 
99  //- Construct as copy setting internal field reference
101  (
104  );
105 
106  //- Construct and return a clone setting internal field reference
108  (
110  ) const
111  {
113  (
115  );
116  }
117 
118 
119  // Member Functions
120 
121  // Access
122 
123  virtual const vectorField& traction() const
124  {
125  return traction_;
126  }
127 
129  {
130  return traction_;
131  }
132 
133  virtual const scalarField& pressure() const
134  {
135  return pressure_;
136  }
137 
139  {
140  return pressure_;
141  }
142 
143 
144  // Mapping functions
145 
146  //- Map (and resize as needed) from self given a mapping object
147  // Used to update fields following mesh topology change
148  virtual void autoMap(const fvPatchFieldMapper&);
149 
150  //- Reverse map the given fvPatchField onto this fvPatchField
151  // Used to reconstruct fields
152  virtual void rmap(const fvPatchVectorField&, const labelList&);
153 
154  //- Reset the fvPatchField to the given fvPatchField
155  // Used for mesh to mesh mapping
156  virtual void reset(const fvPatchVectorField&);
157 
158 
159  //- Update the coefficients associated with the patch field
160  virtual void updateCoeffs();
161 
162  //- Write
163  virtual void write(Ostream&) const;
164 };
165 
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 } // End namespace Foam
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #endif
174 
175 // ************************************************************************* //
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
TypeName("tractionDisplacement")
Runtime type information.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void reset(const fvPatchVectorField &)
Reset the fvPatchField to the given fvPatchField.
virtual void write(Ostream &) const
Write.
tractionDisplacementCorrectionFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Namespace for OpenFOAM.