src/solidModels/fvPatchFields/timeVaryingSolidTraction/timeVaryingSolidTractionFvPatchVectorField.H

   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.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 Class
  25     timeVaryingSolidTractionFvPatchVectorField
  26
  27 Description
  28     Time-varying traction boundary condition for solid foam solvers.
  29     Suitable for for total strain or incremental strain total or
  30     updated Lagrangian approaches.
  31     Contains thermal-elastic, plastic, non-linear terms if required.
  32     And non-orthogonal correction.
  33
  34     Example of the boundary condition specification:
  35     @verbatim
  36     inlet
  37     {
  38         type            timeVaryingSolidTraction;
  39         field           U; // or DU
  40         nonLinear       OFF;
  41         fileName        "$FOAM_CASE/time-series";
  42         outOfBounds     clamp;           // (error|warn|clamp|repeat)
  43     }
  44     @endverbatim
  45
  46 Author
  47     Philip Cardiff
  48
  49 SourceFiles
  50     timeVaryingSolidTractionFvPatchVectorField.C
  51
  52 \*---------------------------------------------------------------------------*/
  53
  54 #ifndef timeVaryingSolidTractionFvPatchVectorField_H
  55 #define timeVaryingSolidTractionFvPatchVectorField_H
  56
  57 #include "fvPatchFields.H"
  58 #include "solidTractionFvPatchVectorField.H"
  59 #include "interpolationTable.H"
  60 #include "Switch.H"
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 namespace Foam
  65 {
  66
  67 /*---------------------------------------------------------------------------*\
  68              Class timeVaryingSolidTractionFvPatchVectorField Declaration
  69 \*---------------------------------------------------------------------------*/
  70
  71 class timeVaryingSolidTractionFvPatchVectorField
  72 :
  73     public solidTractionFvPatchVectorField
  74 {
  75
  76     // Private Data
  77
  78         //- The time series being used, including the bounding treatment
  79         interpolationTable<vector> timeSeries_;
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("timeVaryingSolidTraction");
  86
  87
  88     // Constructors
  89
  90         //- Construct from patch and internal field
  91         timeVaryingSolidTractionFvPatchVectorField
  92         (
  93             const fvPatch&,
  94             const DimensionedField<vector, volMesh>&
  95         );
  96
  97         //- Construct from patch, internal field and dictionary
  98         timeVaryingSolidTractionFvPatchVectorField
  99         (
 100             const fvPatch&,
 101             const DimensionedField<vector, volMesh>&,
 102             const dictionary&
 103         );
 104
 105         //- Construct by mapping given
 106         //  timeVaryingSolidTractionFvPatchVectorField onto a new patch
 107         timeVaryingSolidTractionFvPatchVectorField
 108         (
 109             const timeVaryingSolidTractionFvPatchVectorField&,
 110             const fvPatch&,
 111             const DimensionedField<vector, volMesh>&,
 112             const fvPatchFieldMapper&
 113         );
 114
 115         //- Construct as copy
 116         timeVaryingSolidTractionFvPatchVectorField
 117         (
 118             const timeVaryingSolidTractionFvPatchVectorField&
 119         );
 120
 121         //- Construct and return a clone
 122         virtual tmp<fvPatchVectorField> clone() const
 123         {
 124             return tmp<fvPatchVectorField>
 125             (
 126                 new timeVaryingSolidTractionFvPatchVectorField(*this)
 127             );
 128         }
 129
 130         //- Construct as copy setting internal field reference
 131         timeVaryingSolidTractionFvPatchVectorField
 132         (
 133             const timeVaryingSolidTractionFvPatchVectorField&,
 134             const DimensionedField<vector, volMesh>&
 135         );
 136
 137         //- Construct and return a clone setting internal field reference
 138         virtual tmp<fvPatchVectorField> clone
 139         (
 140             const DimensionedField<vector, volMesh>& iF
 141         ) const
 142         {
 143             return tmp<fvPatchVectorField>
 144             (
 145                 new timeVaryingSolidTractionFvPatchVectorField(*this, iF)
 146             );
 147         }
 148
 149
 150     // Member functions
 151
 152         // Access
 153
 154             //- Return the time series used
 155             const interpolationTable<vector>& timeSeries() const
 156             {
 157                 return timeSeries_;
 158             }
 159
 160         // Mapping functions
 161
 162             //- Map (and resize as needed) from self given a mapping object
 163             virtual void autoMap
 164             (
 165                 const fvPatchFieldMapper&
 166             );
 167
 168             //- Reverse map the given fvPatchField onto this fvPatchField
 169             virtual void rmap
 170             (
 171                 const fvPatchVectorField&,
 172                 const labelList&
 173             );
 174
 175
 176         //- Update the coefficients associated with the patch field
 177         virtual void updateCoeffs();
 178
 179         //- Write
 180         virtual void write(Ostream&) const;
 181 };
 182
 183
 184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 185
 186 } // End namespace Foam
 187
 188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 189
 190 #endif
 191
 192 // ************************************************************************* //