verteq.hpp

Go to the documentation of this file.

#ifndef OPM_VERTEQ_VERTEQ_HPP_INCLUDED
#define OPM_VERTEQ_VERTEQ_HPP_INCLUDED

// Copyright (C) 2013 Uni Research AS
// This file is licensed under the GNU General Public License v3.0

#include <string>
#include <vector>

#ifndef OPM_VERTEQ_VISIBILITY_HPP_INCLUDED
#include <opm/verteq/visibility.hpp>
#endif /* OPM_VERTEQ_VISIBILITY_HPP_INCLUDED */

// forward declaration
struct FlowBoundaryConditions;
struct UnstructuredGrid;
struct Wells;

namespace Opm {

class IncompPropertiesInterface;
class TwophaseState;

namespace parameter {
class ParameterGroup;
} // namespace parameter

class OPM_VERTEQ_PUBLIC VertEq
{
protected:
    // you are not supposed to call the constructor yourself; instead use
    // the static create function provided
    VertEq () {}
public:
    static VertEq* create (const std::string& title,
                           const Opm::parameter::ParameterGroup& args,
                           const UnstructuredGrid& fullGrid,
                           const IncompPropertiesInterface& fullProps,
                           const Wells* fullWells,
                           const std::vector<double>& fullSrc,
                           const FlowBoundaryConditions* fullBcs,
                           const double* fullGravity);

    // virtual destructor, actual functionality relayed to real impl.
    virtual ~VertEq () {}

    virtual const UnstructuredGrid& grid () = 0;

    virtual const Wells* wells () = 0;

    virtual const IncompPropertiesInterface& props () = 0;

    virtual const std::vector<double>& src () = 0;

    virtual const FlowBoundaryConditions* bcs () = 0;

    virtual const double* gravity () = 0;

    virtual void upscale (const TwophaseState& fineScale,
                          TwophaseState& coarseScale) = 0;

    virtual void downscale (const TwophaseState& coarseScale,
                            TwophaseState& fineScale) = 0;

    virtual void notify(const TwophaseState& coarseScale) = 0;
};

} // namespace Opm

#endif /* OPM_VERTEQ_VERTEQ_HPP_INCLUDED */