displacementLinearMotionSolver.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2018-2024 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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::displacementLinearMotionSolver
 
Description
    Mesh motion solver simple linear expansion and contraction of a mesh
    region defined by a motion axis and the extents of the motion.
 
    Example:
    \verbatim
        mover           motionSolver;
 
        libs            ("libfvMotionSolvers.so");
 
        motionSolver    displacementLinearMotion;
 
        axis            (0 1 0);
        xFixed          0.8;
        xMoving         0;
        displacement    table
        (
            (0 0)
            (4 0.7)
        );
    \endverbatim
 
    This mesh is compressed between \c xFixed and \c xMoving in the direction
    \c axis between time 0 and 4 with a maximum displacement of 0.7.
    The mesh beyond \c xFixed is fixed and beyond \c xMoving moves with maximum
    displacement.
 
SourceFiles
    displacementLinearMotionSolver.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef displacementLinearMotionSolver_H
#define displacementLinearMotionSolver_H
 
#include "points0MotionSolver.H"
#include "Function1.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
            Class displacementLinearMotionSolver Declaration
\*---------------------------------------------------------------------------*/
 
class displacementLinearMotionSolver
:
    public points0MotionSolver
{
    // Private Data
 
        //- Axis of the linear motion
        vector axis_;
 
        //- The location of the end of motion
        scalar xFixed_;
 
        //- The location moving with the specified displacement
        scalar xMoving_;
 
        //- The displacement as a function of time
        autoPtr<Function1<scalar>> displacement_;
 
 
public:
 
    //- Runtime type information
    TypeName("displacementLinear");
 
 
    // Constructors
 
        //- Construct from polyMesh and dictionary
        displacementLinearMotionSolver
        (
            const word& name,
            const polyMesh&,
            const dictionary&
        );
 
        //- Disallow default bitwise copy construction
        displacementLinearMotionSolver
        (
            const displacementLinearMotionSolver&
        ) = delete;
 
 
    //- Destructor
    ~displacementLinearMotionSolver();
 
 
    // Member Functions
 
        //- Return point location obtained from the current motion field
        virtual tmp<pointField> curPoints() const;
 
        //- Solve for motion
        virtual void solve()
        {}
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const displacementLinearMotionSolver&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //