DARegDbSinglePhaseTransportModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Register singlePhaseTransportModel to Foam::fvMesh
 
        Example:
 
        To register a singlePhaseTransportModel object to fvMesh:
 
        singlePhaseTransportModel laminarTransport(U, phi);
        DARegDbSinglePhaseTransportModel sg(mesh,laminarTransport);
 
        Then, to get the registered nearWallDist object from fvMesh:
 
        const DARegDbSinglePhaseTransportModel& sg1= 
            mesh.thisDb().lookupObject<DARegDbSinglePhaseTransportModel>(
                "DARegDbSinglePhaseTransportModel");
        const singlePhaseTransportModel& lt1 = sg1.getObject();
 
\*---------------------------------------------------------------------------*/
 
#ifndef DARegDbSinglePhaseTransportModel_H
#define DARegDbSinglePhaseTransportModel_H
 
#include "fvOptions.H"
#include "singlePhaseTransportModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DARegDbSinglePhaseTransportModel Declaration
\*---------------------------------------------------------------------------*/
 
class DARegDbSinglePhaseTransportModel
    : public regIOobject
{
 
private:
    DARegDbSinglePhaseTransportModel(const DARegDbSinglePhaseTransportModel&);
 
    void operator=(const DARegDbSinglePhaseTransportModel&);
 
    const fvMesh& mesh_;
 
    const singlePhaseTransportModel& singlePhaseTransportModel_;
 
public:
    DARegDbSinglePhaseTransportModel(
        const fvMesh& mesh,
        const singlePhaseTransportModel& singlePhaseTransportModel);
 
    virtual ~DARegDbSinglePhaseTransportModel();
 
    const singlePhaseTransportModel& getObject() const
    {
        return singlePhaseTransportModel_;
    }
 
    bool writeData(Ostream& os) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //