00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::calcTypes::magSqr 00026 00027 Description 00028 Calculates and writes the magnitude-sqaured of a field for each time 00029 00030 SourceFiles 00031 magSqr.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef magSqr_H 00036 #define magSqr_H 00037 00038 #include <foamCalcFunctions/calcType.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 00045 namespace calcTypes 00046 { 00047 00048 /*---------------------------------------------------------------------------*\ 00049 Class magSqr Declaration 00050 \*---------------------------------------------------------------------------*/ 00051 00052 class magSqr 00053 : 00054 public calcType 00055 { 00056 // Private Member Functions 00057 00058 //- Disallow default bitwise copy construct 00059 magSqr(const magSqr&); 00060 00061 //- Disallow default bitwise assignment 00062 void operator=(const magSqr&); 00063 00064 00065 protected: 00066 00067 // Member Functions 00068 00069 // Calculation routines 00070 00071 //- Initialise - typically setting static variables, 00072 // e.g. command line arguments 00073 virtual void init(); 00074 00075 //- Pre-time loop calculations 00076 virtual void preCalc 00077 ( 00078 const argList& args, 00079 const Time& runTime, 00080 const fvMesh& mesh 00081 ); 00082 00083 //- Time loop calculations 00084 virtual void calc 00085 ( 00086 const argList& args, 00087 const Time& runTime, 00088 const fvMesh& mesh 00089 ); 00090 00091 00092 // I-O 00093 00094 //- Write component fields 00095 template<class Type> 00096 void writeMagSqrField 00097 ( 00098 const IOobject& header, 00099 const fvMesh& mesh, 00100 bool& processed 00101 ); 00102 00103 00104 public: 00105 00106 //- Runtime type information 00107 TypeName("magSqr"); 00108 00109 00110 // Constructors 00111 00112 //- Construct null 00113 magSqr(); 00114 00115 00116 // Destructor 00117 00118 virtual ~magSqr(); 00119 }; 00120 00121 00122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00123 00124 } // End namespace calcTypes 00125 } // End namespace Foam 00126 00127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00128 00129 #ifdef NoRepository 00130 # include <foamCalcFunctions/writeMagSqrField.C> 00131 #endif 00132 00133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00134 00135 #endif 00136 00137 // ************************ vim: set sw=4 sts=4 et: ************************ //
