optMeshMovementNULL.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2007-2019 PCOpt/NTUA
    Copyright (C) 2013-2019 FOSS GP
    Copyright (C) 2019 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::optMeshMovementNULL

Description
    A dummy optMeshMovement object

SourceFiles
    optMeshMovementNULL.C

\*---------------------------------------------------------------------------*/

#ifndef optMeshMovementNULL_H
#define optMeshMovementNULL_H

#include "optMeshMovement.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                     Class optMeshMovementNULL Declaration
\*---------------------------------------------------------------------------*/

class optMeshMovementNULL
:
    public optMeshMovement
{
private:

    // Private Member Functions

        //- No copy construct
        optMeshMovementNULL(const optMeshMovementNULL&) = delete;

        //- No copy assignment
        void operator=(const optMeshMovementNULL&) = delete;


public:

    //- Runtime type information
    TypeName("none");


    // Constructors

        //- Construct from components
        optMeshMovementNULL
        (
            fvMesh& mesh,
            const dictionary& dict,
            const labelList& patchIDs
        );


    //- Destructor
    virtual ~optMeshMovementNULL() = default;


    // Member Functions

       //- Calculates surface mesh movement
       void moveMesh();

       //- Compute eta value based on max displacement
       virtual scalar computeEta(const scalarField& correction);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //