mesh_function.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_MESH_FUNCTION_H
#define LIBMESH_MESH_FUNCTION_H

// Local Includes
#include "libmesh/function_base.h"
#include "libmesh/dense_vector.h"
#include "libmesh/vector_value.h"
#include "libmesh/tensor_value.h"
#include "libmesh/tree_base.h"
#include "libmesh/parallel_object.h"

// C++ includes
#include <cstddef>
#include <vector>

namespace libMesh
{


// Forward Declarations
template <typename T> class DenseVector;
class EquationSystems;
template <typename T> class NumericVector;
class DofMap;
class PointLocatorBase;



// ------------------------------------------------------------
// MeshFunction class definition
class MeshFunction : public FunctionBase<Number>,
                     public ParallelObject
{
public:

  MeshFunction (const EquationSystems& eqn_systems,
                const NumericVector<Number>& vec,
                const DofMap& dof_map,
                const std::vector<unsigned int>& vars,
                const FunctionBase<Number>* master=NULL);

  MeshFunction (const EquationSystems& eqn_systems,
                const NumericVector<Number>& vec,
                const DofMap& dof_map,
                const unsigned int var,
                const FunctionBase<Number>* master=NULL);

  ~MeshFunction ();



  void init () { this->init(Trees::NODES); }


  virtual void init (const Trees::BuildType point_locator_build_type);

  virtual void clear ();

  virtual UniquePtr<FunctionBase<Number> > clone () const;

  Number operator() (const Point& p,
                     const Real time=0.);

  Gradient gradient (const Point& p,
                     const Real time=0.);

#ifdef LIBMESH_ENABLE_SECOND_DERIVATIVES

  Tensor hessian (const Point& p,
                  const Real time=0.);
#endif

  void operator() (const Point& p,
                   const Real time,
                   DenseVector<Number>& output);

  void operator() (const Point& p,
                   const Real time,
                   DenseVector<Number>& output,
                   const std::set<subdomain_id_type>* subdomain_ids);

  void gradient (const Point& p,
                 const Real time,
                 std::vector<Gradient>& output,
                 const std::set<subdomain_id_type>* subdomain_ids = NULL);

  void hessian (const Point& p,
                const Real time,
                std::vector<Tensor>& output,
                const std::set<subdomain_id_type>* subdomain_ids = NULL);

  const PointLocatorBase& get_point_locator (void) const;

  void enable_out_of_mesh_mode(const DenseVector<Number>& value);

  void enable_out_of_mesh_mode(const Number& value);

  void disable_out_of_mesh_mode(void);

  void set_point_locator_tolerance(Real tol);

  void unset_point_locator_tolerance();

protected:

  const Elem* find_element( const Point& p,
                            const std::set<subdomain_id_type>* subdomain_ids = NULL ) const;

  const EquationSystems& _eqn_systems;

  const NumericVector<Number>& _vector;

  const DofMap& _dof_map;

  const std::vector<unsigned int> _system_vars;

  PointLocatorBase* _point_locator;

  bool _out_of_mesh_mode;

  DenseVector<Number> _out_of_mesh_value;
};




// ------------------------------------------------------------
// MeshFunction inline methods


} // namespace libMesh


#endif // LIBMESH_MESH_FUNCTION_H