OpenFOAM-dev / data /src /lagrangian /molecularDynamics /potential /tetherPotential /basic /tetherPotential.H
| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2011-2023 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::tetherPotential | |
| Description | |
| SourceFiles | |
| tetherPotential.C | |
| tetherPotentialNew.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class tetherPotential Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class tetherPotential | |
| { | |
| protected: | |
| // Protected data | |
| word name_; | |
| dictionary tetherPotentialProperties_; | |
| public: | |
| //- Runtime type information | |
| TypeName("tetherPotential"); | |
| // Declare run-time constructor selection table | |
| declareRunTimeSelectionTable | |
| ( | |
| autoPtr, | |
| tetherPotential, | |
| dictionary, | |
| ( | |
| const word& name, | |
| const dictionary& tetherPotentialProperties | |
| ), | |
| (name, tetherPotentialProperties) | |
| ); | |
| // Constructors | |
| //- Construct from components | |
| tetherPotential | |
| ( | |
| const word& name, | |
| const dictionary& tetherPotentialProperties | |
| ); | |
| //- Disallow default bitwise copy construction | |
| tetherPotential(const tetherPotential&) = delete; | |
| // Selectors | |
| //- Return a reference to the selected viscosity model | |
| static autoPtr<tetherPotential> New | |
| ( | |
| const word& name, | |
| const dictionary& tetherPotentialProperties | |
| ); | |
| //- Destructor | |
| virtual ~tetherPotential() | |
| {} | |
| // Member Functions | |
| virtual scalar energy (const vector r) const = 0; | |
| virtual vector force (const vector r) const = 0; | |
| const dictionary& tetherPotentialProperties() const | |
| { | |
| return tetherPotentialProperties_; | |
| } | |
| //- Read tetherPotential dictionary | |
| virtual bool read(const dictionary& tetherPotentialProperties) = 0; | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const tetherPotential&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |