t8_geometry_analytic.hxx

Go to the documentation of this file.

/*
  This file is part of t8code.
  t8code is a C library to manage a collection (a forest) of multiple
  connected adaptive space-trees of general element classes in parallel.
 
  Copyright (C) 2015 the developers
 
  t8code is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
 
  t8code 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 General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with t8code; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
#ifndef T8_GEOMETRY_ANALYTIC_HXX
#define T8_GEOMETRY_ANALYTIC_HXX
 
#include <t8.h>
#include <t8_geometry/t8_geometry_base.hxx>
 
typedef void        (*t8_geom_analytic_fn) (t8_cmesh_t cmesh,
                                            t8_gloidx_t gtreeid,
                                            const double *ref_coords,
                                            double out_coords[3],
                                            const void *tree_data,
                                            const void *user_data);
 
typedef void        (*t8_geom_analytic_jacobian_fn) (t8_cmesh_t cmesh,
                                                     t8_gloidx_t gtreeid,
                                                     const double *ref_coords,
                                                     double *jacobian,
                                                     const void *tree_data,
                                                     const void *user_data);
 
/* TODO: Document. */
typedef void        (*t8_geom_load_tree_data_fn) (t8_cmesh_t cmesh,
                                                  t8_gloidx_t gtreeid,
                                                  const void **tree_data);
 
struct t8_geometry_analytic:public t8_geometry
{
public:
 
  t8_geometry_analytic (int dimension, const char *name,
                        t8_geom_analytic_fn analytical,
                        t8_geom_analytic_jacobian_fn jacobian,
                        t8_geom_load_tree_data_fn load_tree_data,
                        const void *user_data);
 
                      virtual ~ t8_geometry_analytic ()
  {
    /* Nothing to do */
  }
 
  virtual void        t8_geom_evaluate (t8_cmesh_t cmesh,
                                        t8_gloidx_t gtreeid,
                                        const double *ref_coords,
                                        double out_coords[3]) const;
 
  virtual void        t8_geom_evalute_jacobian (t8_cmesh_t cmesh,
                                                t8_gloidx_t gtreeid,
                                                const double *ref_coords,
                                                double *jacobian) const;
 
  virtual void        t8_geom_load_tree_data (t8_cmesh_t cmesh,
                                              t8_gloidx_t gtreeid);
 
  inline const void  *t8_geom_analytic_get_user_data ()
  {
    return user_data;
  }
 
private:
  t8_geom_analytic_fn analytical_function; 
  t8_geom_analytic_jacobian_fn jacobian;   
  t8_geom_load_tree_data_fn load_tree_data; 
  const void         *tree_data;        
  const void         *user_data;        
};
 
/* TODO: Document */
void                t8_geom_load_tree_data_vertices (t8_cmesh_t cmesh,
                                                     t8_gloidx_t gtreeid,
                                                     const void
                                                     **vertices_out);
 
#endif /* !T8_GEOMETRY_ANALYTICAL_HXX! */