freeSurfaceVelocityFvPatchVectorField.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) 2019 Zeljko Tukovic, FSB Zagreb.
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
26Class
27 Foam::freeSurfaceVelocityFvPatchVectorField
28
29Group
30 grpOutletBoundaryConditions
31
32Description
33 This boundary condition provides a velocity outlet boundary condition for
34 free surface patches.
35
36SourceFiles
37 freeSurfaceVelocityFvPatchVectorField.C
38
39\*---------------------------------------------------------------------------*/
40
41#ifndef freeSurfaceVelocityFvPatchVectorField_H
42#define freeSurfaceVelocityFvPatchVectorField_H
43
44#include "fvPatchFields.H"
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51
52/*---------------------------------------------------------------------------*\
53 Class freeSurfaceVelocityFvPatchVectorField Declaration
54\*---------------------------------------------------------------------------*/
57:
58 public fixedGradientFvPatchVectorField
59{
60public:
61
62 //- Runtime type information
63 TypeName("freeSurfaceVelocity");
64
65
66 // Constructors
67
68 //- Construct from patch and internal field
70 (
71 const fvPatch&,
73 );
74
75 //- Construct from patch, internal field and dictionary
77 (
78 const fvPatch&,
80 const dictionary&
81 );
82
83 //- Construct by mapping given freeSurfaceVelocityFvPatchVectorField
84 // onto a new patch
86 (
88 const fvPatch&,
91 );
92
93 //- Construct and return a clone
94 virtual tmp<fvPatchVectorField> clone() const
95 {
97 (
99 );
100 }
101
102 //- Construct as copy setting internal field reference
104 (
107 );
108
109 //- Construct and return a clone setting internal field reference
111 (
113 ) const
114 {
116 (
118 );
119 }
120
121
122 // Member functions
123
124 //- Update the coefficients associated with the patch field
125 virtual void updateCoeffs();
126
127 //- Write
128 virtual void write(Ostream&) const;
129};
130
131
132// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133
134} // End namespace Foam
135
136// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137
138#endif
139
140// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
This boundary condition provides a velocity outlet boundary condition for free surface patches.
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
TypeName("freeSurfaceVelocity")
Runtime type information.
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73