Initial commit of NavalHydro package from Wikki to the ShipHydroSIG
[ShipHydroSIG.git] / src / vofDynamicMesh / lnInclude / numericalBeach.H
blob50d42f115ba612268041f392b56ce67691cad1c2
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright held by original author
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Description
26     numerical damping in the internalfield for selected boundaries
28 Class
29     Foam::numericalBeach
31 Author
32     Henrik Rusche, Wikki GmbH.  All rights reserved.
34 SourceFiles
35     numericalBeach.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef numericalBeach_H
40 #define numericalBeach_H
42 #include "volFields.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
49 /*---------------------------------------------------------------------------*\
50                            Class numericalBeach Declaration
51 \*---------------------------------------------------------------------------*/
53 class numericalBeach
56     // Private data
58         //- Velocity field to be damped at boundaries
59         volVectorField& U_;
62     // Private Member Functions
64         //- Disallow default bitwise copy construct
65         numericalBeach(const numericalBeach&);
67         //- Disallow default bitwise assignment
68         void operator=(const numericalBeach&);
71 public:
73     // Constructors
75         //- Construct from components
76         numericalBeach(volVectorField& U);
79     // Destructor
81         ~numericalBeach();
84     // Member Functions
86         // Access
88         //- Return the source term for the momentum equation
89         tmp<volScalarField> damping() const;
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 } // End namespace Foam
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 #endif
101 // ************************************************************************* //