tractionDisplacementFvPatchVectorField.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 | Copyright (C) 2011 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 Class
25  Foam::tractionDisplacementFvPatchVectorField
26 
27 Description
28  Fixed traction boundary condition for the standard linear elastic, fixed
29  coefficient displacement equation.
30 
31 SourceFiles
32  tractionDisplacementFvPatchVectorField.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef tractionDisplacementFvPatchVectorField_H
37 #define tractionDisplacementFvPatchVectorField_H
38 
39 #include "fvPatchFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class tractionDisplacementFvPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public fixedGradientFvPatchVectorField
54 {
55 
56  // Private Data
57 
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("tractionDisplacement");
66 
67 
68  // Constructors
69 
70  //- Construct from patch and internal field
72  (
73  const fvPatch&,
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  // tractionDisplacementFvPatchVectorField onto a new patch
88  (
90  const fvPatch&,
92  const fvPatchFieldMapper&
93  );
94 
95  //- Construct as copy
97  (
99  );
100 
101  //- Construct and return a clone
102  virtual tmp<fvPatchVectorField> clone() const
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 
139  virtual vectorField& traction()
140  {
141  return traction_;
142  }
143 
144  virtual const scalarField& pressure() const
145  {
146  return pressure_;
147  }
148 
149  virtual scalarField& pressure()
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
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
Foam::tractionDisplacementFvPatchVectorField::traction
virtual const vectorField & traction() const
Definition: tractionDisplacementFvPatchVectorField.H:133
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::tractionDisplacementFvPatchVectorField::tractionDisplacementFvPatchVectorField
tractionDisplacementFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Foam::tractionDisplacementFvPatchVectorField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::tractionDisplacementFvPatchVectorField::clone
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
Definition: tractionDisplacementFvPatchVectorField.H:101
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::tractionDisplacementFvPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::tractionDisplacementFvPatchVectorField::pressure
virtual scalarField & pressure()
Definition: tractionDisplacementFvPatchVectorField.H:148
Foam::tractionDisplacementFvPatchVectorField::pressure_
scalarField pressure_
Definition: tractionDisplacementFvPatchVectorField.H:58
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::tractionDisplacementFvPatchVectorField
Fixed traction boundary condition for the standard linear elastic, fixed coefficient displacement equ...
Definition: tractionDisplacementFvPatchVectorField.H:50
fixedGradientFvPatchFields.H
fvPatchFields.H
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::tractionDisplacementFvPatchVectorField::traction
virtual vectorField & traction()
Definition: tractionDisplacementFvPatchVectorField.H:138
Foam::tractionDisplacementFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:45
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:53
Foam::tractionDisplacementFvPatchVectorField::traction_
vectorField traction_
Definition: tractionDisplacementFvPatchVectorField.H:57
Foam::tractionDisplacementFvPatchVectorField::rmap
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Foam::tractionDisplacementFvPatchVectorField::pressure
virtual const scalarField & pressure() const
Definition: tractionDisplacementFvPatchVectorField.H:143
Foam::tractionDisplacementFvPatchVectorField::TypeName
TypeName("tractionDisplacement")
Runtime type information.
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:51