DARegDbTurbulenceModelIncompressible.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Register a turbulence model object to Foam::fvMesh
 
        Example:
 
        To register a turbulence model object to fvMesh:
 
        autoPtr<incompressible::turbulenceModel> turbulencePtr(
            incompressible::turbulenceModel::New(U, phi, laminarTransport));
        incompressible::turbulenceModel& turbulence = turbulencePtr();
        DARegDbTurbulenceModelIncompressible turb(mesh,turbulence);
 
        Then, to get the registered turbulence model object from fvMesh:
 
        const DARegDbTurbulenceModelIncompressible& turbDb= 
            mesh.thisDb().lookupObject<DARegDbTurbulenceModelIncompressible>(
                "DARegDbTurbulenceModelIncompressible");
        const incompressible::turbulenceModel& turb1 = turbDb.getObject();
 
\*---------------------------------------------------------------------------*/
 
#ifndef DARegDbTurbulenceModelIncompressible_H
#define DARegDbTurbulenceModelIncompressible_H
 
#include "fvOptions.H"
#include "singlePhaseTransportModel.H"
#include "turbulentTransportModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DARegDbTurbulenceModelIncompressible Declaration
\*---------------------------------------------------------------------------*/
 
class DARegDbTurbulenceModelIncompressible
    : public regIOobject
{
 
private:
    DARegDbTurbulenceModelIncompressible(const DARegDbTurbulenceModelIncompressible&);
 
    void operator=(const DARegDbTurbulenceModelIncompressible&);
 
    const fvMesh& mesh_;
 
    const incompressible::turbulenceModel& turbulenceModel_;
 
public:
    DARegDbTurbulenceModelIncompressible(
        const fvMesh& mesh,
        const incompressible::turbulenceModel& turbulenceModel);
 
    virtual ~DARegDbTurbulenceModelIncompressible();
 
    const incompressible::turbulenceModel& getObject() const
    {
        return turbulenceModel_;
    }
 
    bool writeData(Ostream& os) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //