t8_cmesh_types.h

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_CMESH_TYPES_H
#define T8_CMESH_TYPES_H
 
#include <t8.h>
#include <t8_refcount.h>
#include <t8_data/t8_shmem.h>
#include <t8_geometry/t8_geometry.h>
#include "t8_cmesh_stash.h"
#include "t8_element.h"
 
typedef struct t8_part_tree *t8_part_tree_t;
typedef struct t8_cmesh_trees *t8_cmesh_trees_t;
typedef struct t8_cprofile t8_cprofile_t;       /* Defined below */
 
/* TODO: no longer needed.
 *       User may use set_derived_from, then set_from is non-NULL.
 *       When refinement is desired, level shall be set positive.
 *       When partition is desired, we expect set_partition to be true.
 *       Any combination can be called.
 *       In t8_commit we check whether the parameters are consistent,
 *       and whether a combination is currently supported,
 *       and provide informative error messages both in debug and non-debug.
 */
 
/* Definitions for attribute identifiers that are reserved for a special purpose. 
 * T8_CMESH_NEXT_POSSIBLE_KEY is the first unused key, hence it can be repurposed for different attributes.*/
#define T8_CMESH_VERTICES_ATTRIBUTE_KEY   0     /* Used to store vertex coordinates. */
#define T8_CMESH_GEOMETRY_ATTRIBUTE_KEY   1     /* Used to store the name of a tree's geometry. */
#define T8_CMESH_OCC_EDGE_ATTRIBUTE_KEY    2    /* Used to store which edge is linked to which geometry */
#define T8_CMESH_OCC_EDGE_PARAMETERS_ATTRIBUTE_KEY    3 /* Used to store edge parameters */
#define T8_CMESH_OCC_FACE_ATTRIBUTE_KEY T8_CMESH_OCC_EDGE_PARAMETERS_ATTRIBUTE_KEY + T8_ECLASS_MAX_EDGES        /* Used to store wich face is linked to which surface */
#define T8_CMESH_OCC_FACE_PARAMETERS_ATTRIBUTE_KEY T8_CMESH_OCC_FACE_ATTRIBUTE_KEY + 1  /* Used to store face parameters */
#define T8_CMESH_NEXT_POSSIBLE_KEY T8_CMESH_OCC_FACE_PARAMETERS_ATTRIBUTE_KEY + T8_ECLASS_MAX_FACES     /* The next free value for a t8code attribute key */
 
typedef struct t8_cmesh
{
  /* TODO: make the comments more legible */
  int                 committed; 
  int                 dimension; 
  int                 set_partition; 
  int                 face_knowledge;  
  /* TODO: Define a maximum allowed refinemet level */
  int8_t              set_refine_level; 
  t8_scheme_cxx_t    *set_refine_scheme; 
  t8_scheme_cxx_t    *set_partition_scheme; 
  int8_t              set_partition_level; 
  struct t8_cmesh    *set_from; 
  int                 mpirank;  
  int                 mpisize;  
  t8_refcount_t       rc; 
  t8_gloidx_t         num_trees;   
  t8_locidx_t         num_local_trees; 
  t8_locidx_t         num_ghosts; 
  /* TODO: wouldnt a local num_trees_per_eclass be better?
   *       only as an additional info. we need the global count. i.e. for forest_maxlevel computation.
   */
  t8_locidx_t         num_local_trees_per_eclass[T8_ECLASS_COUNT]; 
  t8_gloidx_t         num_trees_per_eclass[T8_ECLASS_COUNT]; 
  t8_cmesh_trees_t    trees; 
  t8_gloidx_t         first_tree; 
  int8_t              first_tree_shared;
  t8_shmem_array_t    tree_offsets;
  t8_geometry_handler_t *geometry_handler;  
#ifdef T8_ENABLE_DEBUG
  t8_locidx_t         inserted_trees; 
  t8_locidx_t         inserted_ghosts; 
#endif
  t8_stash_t          stash; 
  t8_cprofile_t      *profile; 
}
t8_cmesh_struct_t;
 
/* TODO: cghost could be the same type as ctree.
 *       treeid for ghosts then negative?!
 *       1. typedef cghost ctree
 *       2. completely replace
 */
/* TODO: document */
typedef struct t8_cghost
{
  t8_gloidx_t         treeid; 
  t8_eclass_t         eclass; 
  size_t              neigh_offset; 
  size_t              att_offset;    
  /* TODO: Could be a size_t */
  int                 num_attributes; 
}
t8_cghost_struct_t;
 
typedef struct t8_ctree
{
  t8_locidx_t         treeid; 
  /* TODO: The local id of a tree should be clear from context, the entry can
   *       be optimized out. */
  t8_eclass_t         eclass; 
  size_t              neigh_offset;  
  size_t              att_offset;    
  /* TODO: Could be a size_t */
  int                 num_attributes; 
}
t8_ctree_struct_t;
 
typedef struct t8_attribute_info
{
  int                 package_id;
  int                 key;
  size_t              attribute_offset;
  /* TODO: eventually remove the size */
  size_t              attribute_size;
} t8_attribute_info_struct_t;
 
/* TODO: document, process is a bad naming, since it does not refer to MPI ranks here */
typedef struct t8_cmesh_trees
{
  sc_array_t         *from_proc;        /* array of t8_part_tree, one for each process */
  int                *tree_to_proc;     /* for each tree its process */
  int                *ghost_to_proc;    /* for each ghost its process */
  sc_hash_t          *ghost_globalid_to_local_id;       /* A hash table storing the map
                                                           global_id -> local_id for the ghost trees.
                                                           The local_id is the local ghost id starting at num_local_trees  */
  sc_mempool_t       *global_local_mempool;     /* Memory pool for the entries in the hash table */
}
t8_cmesh_trees_struct_t;
 
/* TODO: document */
typedef struct t8_part_tree
{
  char               *first_tree;       /* Stores the trees, the ghosts and the attributes.
                                           The last 2*sizeof(t8_locidx) bytes store num_trees and num_ghosts */
  t8_locidx_t         first_tree_id;    /* local tree_id of the first tree. -1 if num_trees = 0 */
  t8_locidx_t         first_ghost_id;   /* TODO: document. -1 if num_ghost=0, 0 for the first part, (not num_local_trees!)
                                           0 <= first_ghost_id < num_ghosts */
  t8_locidx_t         num_trees;
  t8_locidx_t         num_ghosts;
}
t8_part_tree_struct_t;
 
/* TODO: Extend this structure with meaningful entries.
 *       Maybe the number of shipped trees per process is useful?
 */
typedef struct t8_cprofile
{
  t8_locidx_t         partition_trees_shipped;
  t8_locidx_t         partition_ghosts_shipped;
  t8_locidx_t         partition_trees_recv;
  t8_locidx_t         partition_ghosts_recv;
  size_t              partition_bytes_sent;
  int                 partition_procs_sent; 
  int                 first_tree_shared; 
  double              partition_runtime; 
  double              commit_runtime; 
  double              geometry_evaluate_num_calls; 
  double              geometry_evaluate_runtime; 
}
t8_cprofile_struct_t;
 
#define T8_CPROFILE_NUM_STATS 11
 
#endif /* !T8_CMESH_TYPES_H */