velocity_penalty.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// GRINS - General Reacting Incompressible Navier-Stokes
//
// Copyright (C) 2014-2017 Paul T. Bauman, Roy H. Stogner
// Copyright (C) 2010-2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library 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.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-


#ifndef GRINS_VELOCITY_PENALTY_H
#define GRINS_VELOCITY_PENALTY_H

// GRINS
#include "grins_config.h"
#include "grins/assembly_context.h"
#include "grins/cached_values.h"
#include "grins/velocity_penalty_base.h"

// libMesh
#include "libmesh/getpot.h"

// C++
#include <string>

namespace GRINS
{

  /*
    This physics class imposes a penalty on any velocity component in
    the direction of (and proportional to) a specified vector field.
  */
  template<class Viscosity>
  class VelocityPenalty : public VelocityPenaltyBase<Viscosity>
  {
  public:

    VelocityPenalty( const std::string& physics_name, const GetPot& input );

    ~VelocityPenalty();

    virtual void init_context( AssemblyContext& context );

    virtual void register_postprocessing_vars( const GetPot& input,
                                               PostProcessedQuantities<libMesh::Real>& postprocessing );

    // residual and jacobian calculations
    // element_*, side_* as *time_derivative, *constraint, *mass_residual

    // Constraint part(s)
    virtual void element_time_derivative( bool compute_jacobian,
                                          AssemblyContext& context );

    virtual void compute_postprocessed_quantity( unsigned int quantity_index,
                                                 const AssemblyContext& context,
                                                 const libMesh::Point& point,
                                                 libMesh::Real& value );

  private:

    unsigned int _velocity_penalty_x_index;

    unsigned int _velocity_penalty_y_index;

    unsigned int _velocity_penalty_z_index;

    unsigned int _velocity_penalty_base_x_index;

    unsigned int _velocity_penalty_base_y_index;

    unsigned int _velocity_penalty_base_z_index;

    VelocityPenalty();
  };

} // end namespace block

#endif // GRINS_VELOCITY_PENALTY_H