Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / applications / solvers / solidMechanics / deprecatedSolvers / materialModels / fvPatchFields / tractionDisplacement / tractionDisplacementFvPatchVectorField.H
blobbd5d90db7ce1d05b02ed07073b70b34c3045a5b9
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     tractionDisplacementFvPatchVectorField
27 Description
28     Fixed traction boundary condition for the standard linear elastic, fixed
29     coefficient displacement equation (stressedFoam).
31 Author
32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
34 SourceFiles
35     tractionDisplacementFvPatchVectorField.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef tractionDisplacementFvPatchVectorField_H
40 #define tractionDisplacementFvPatchVectorField_H
42 #include "fvPatchFields.H"
43 #include "fixedGradientFvPatchFields.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 namespace Foam
50 /*---------------------------------------------------------------------------*\
51              Class tractionDisplacementFvPatchVectorField Declaration
52 \*---------------------------------------------------------------------------*/
54 class tractionDisplacementFvPatchVectorField
56     public fixedGradientFvPatchVectorField
59     // Private Data
61         //- Name of the displacement field
62         const word UName_;
64         //- Name of rheology model
65         const word rheologyName_;
67         //- Traction
68         vectorField traction_;
70         //- Pressure
71         scalarField pressure_;
74 public:
76     //- Runtime type information
77     TypeName("tractionDisplacement");
80     // Constructors
82         //- Construct from patch and internal field
83         tractionDisplacementFvPatchVectorField
84         (
85             const fvPatch&,
86             const DimensionedField<vector, volMesh>&
87         );
89         //- Construct from patch, internal field and dictionary
90         tractionDisplacementFvPatchVectorField
91         (
92             const fvPatch&,
93             const DimensionedField<vector, volMesh>&,
94             const dictionary&
95         );
97         //- Construct by mapping given
98         //  tractionDisplacementFvPatchVectorField onto a new patch
99         tractionDisplacementFvPatchVectorField
100         (
101             const tractionDisplacementFvPatchVectorField&,
102             const fvPatch&,
103             const DimensionedField<vector, volMesh>&,
104             const fvPatchFieldMapper&
105         );
107         //- Construct as copy
108         tractionDisplacementFvPatchVectorField
109         (
110             const tractionDisplacementFvPatchVectorField&
111         );
113         //- Construct and return a clone
114         virtual tmp<fvPatchVectorField> clone() const
115         {
116             return tmp<fvPatchVectorField>
117             (
118                 new tractionDisplacementFvPatchVectorField(*this)
119             );
120         }
122         //- Construct as copy setting internal field reference
123         tractionDisplacementFvPatchVectorField
124         (
125             const tractionDisplacementFvPatchVectorField&,
126             const DimensionedField<vector, volMesh>&
127         );
129         //- Construct and return a clone setting internal field reference
130         virtual tmp<fvPatchVectorField> clone
131         (
132             const DimensionedField<vector, volMesh>& iF
133         ) const
134         {
135             return tmp<fvPatchVectorField>
136             (
137                 new tractionDisplacementFvPatchVectorField(*this, iF)
138             );
139         }
142     // Member functions
144         // Access
146             virtual const vectorField& traction() const
147             {
148                 return traction_;
149             }
151             virtual vectorField& traction()
152             {
153                 return traction_;
154             }
156             virtual const scalarField& pressure() const
157             {
158                 return pressure_;
159             }
161             virtual  scalarField& pressure()
162             {
163                 return pressure_;
164             }
166         // Mapping functions
168             //- Map (and resize as needed) from self given a mapping object
169             virtual void autoMap
170             (
171                 const fvPatchFieldMapper&
172             );
174             //- Reverse map the given fvPatchField onto this fvPatchField
175             virtual void rmap
176             (
177                 const fvPatchVectorField&,
178                 const labelList&
179             );
182         //- Update the coefficients associated with the patch field
183         virtual void updateCoeffs();
185         //- Write
186         virtual void write(Ostream&) const;
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 } // End namespace Foam
194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
196 #endif
198 // ************************************************************************* //