navier_stokes_base.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2013:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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 Lesser General Public License for more details.
 */
 
#ifndef __H__UG__PLUGINS__NAVIER_STOKES__NAVIER_STOKES_BASE__
#define __H__UG__PLUGINS__NAVIER_STOKES__NAVIER_STOKES_BASE__
 
// other ug4 modules
#include "common/common.h"
#include "lib_grid/lg_base.h"
 
// library intern headers
#include "lib_disc/spatial_disc/elem_disc/elem_disc_interface.h"
#include "lib_disc/spatial_disc/user_data/data_export.h"
#include "lib_disc/spatial_disc/user_data/data_import.h"
 
namespace ug{
namespace NavierStokes{
 
 
 
template< typename TDomain>
class NavierStokesBase
  : public IElemDisc<TDomain>
{
  protected:
    typedef IElemDisc<TDomain> base_type;
 
    typedef NavierStokesBase<TDomain> this_type;
 
  public:
    static const int dim = base_type::dim;
 
  public:
    NavierStokesBase(const char* functions, const char* subsets);
    NavierStokesBase(const std::vector<std::string>& vFct, const std::vector<std::string>& vSubset);
 
 
    virtual void set_kinematic_viscosity(SmartPtr<CplUserData<number, dim> > user) = 0;
    void set_kinematic_viscosity(number val);
#ifdef UG_FOR_LUA
    void set_kinematic_viscosity(const char* fctName);
#endif
 
    virtual SmartPtr<CplUserData<number, dim> > kinematic_viscosity() = 0;
 
 
    virtual void set_source(SmartPtr<CplUserData<MathVector<dim>, dim> > user) = 0;
    void set_source(const std::vector<number>& vSource);
#ifdef UG_FOR_LUA
    void set_source(const char* fctName);
#endif
 
        void set_exact_jacobian(bool bExactJacobian) { if (bExactJacobian) m_bFullNewtonFactor=1;
                                else m_bFullNewtonFactor=0;}
        void set_exact_jacobian(number fullNewtonFactor){ m_bFullNewtonFactor=fullNewtonFactor; };
 
    public:
    virtual bool requests_local_time_series() {return true;}
 
    virtual std::string disc_type() const = 0;
 
  protected:
    number m_bFullNewtonFactor;
};
 
 
} // namespace NavierStokes
} // end namespace ug
 
#endif /*__H__UG__PLUGINS__NAVIER_STOKES__NAVIER_STOKES_BASE__*/