// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- // vi: set et ts=4 sw=2 sts=2: // SPDX-FileCopyrightInfo: Copyright © DUNE Project contributors, see file LICENSE.md in module root // SPDX-License-Identifier: LGPL-2.1-or-later /*! \file mgio.h * \ingroup gm */ /****************************************************************************/ /* */ /* File: mgio.h */ /* */ /* Purpose: header file for mgio.c */ /* */ /* Author: Klaus Johannsen */ /* Institut fuer Computeranwendungen III */ /* Universitaet Stuttgart */ /* Pfaffenwaldring 27 */ /* 70550 Stuttgart */ /* email: ug@ica3.uni-stuttgart.de */ /* */ /* History: 13.11.96 begin */ /* */ /* Remarks: */ /* */ /****************************************************************************/ /* switch */ #define __MGIO_USE_IN_UG__ /****************************************************************************/ /* */ /* auto include mechanism and other include files */ /* */ /****************************************************************************/ #ifndef __MGIO__ #define __MGIO__ #include #include #ifdef __MGIO_USE_IN_UG__ #include #include "gm.h" #include "rm.h" #endif #include START_UGDIM_NAMESPACE /****************************************************************************/ /* */ /* configuration of interface */ /* */ /****************************************************************************/ #define MGIO_VERSION "UG_IO_2.5" #define __MGIO_USE_IN_UG__ #define MGIO_DIM 3 /****************************************************************************/ /* */ /* defines in the following order */ /* */ /* compile time constants defining static data size (i.e. arrays) */ /* other constants */ /* macros */ /* */ /****************************************************************************/ #ifdef __MGIO_USE_IN_UG__ #define MGIO_PARFILE (nparfiles>1) #define MGIO_DEBUG 0 #define MGIO_BNDP BNDP #define MGIO_BNDS BNDS #undef MGIO_DIM #define MGIO_DIM DIM #define MGIO_MAX_SONS_OF_ELEM MAX_SONS #define MGIO_MAX_EDGES_OF_ELEM MAX_EDGES_OF_ELEM #define MGIO_MAX_CORNERS_OF_ELEM MAX_CORNERS_OF_ELEM #define MGIO_MAX_SIDES_OF_ELEM MAX_SIDES_OF_ELEM #define MGIO_MAX_NEW_CORNERS MAX_NEW_CORNERS_DIM #define MGIO_MAX_CORNERS_OF_SIDE MAX_CORNERS_OF_SIDE #define MGIO_FATHER_SIDE_OFFSET FATHER_SIDE_OFFSET #define MGIO_MAXLEVEL MAXLEVEL #define MGIO_TAGS TAGS #define MGIO_REFINEMENT_SIZE (MGIO_PARFILE ? sizeof(MGIO_REFINEMENT) : sizeof(struct mgio_refinement_seq)) #define MGIO_CG_POINT_SIZE (MGIO_PARFILE ? (sizeof(MGIO_CG_POINT)) : (sizeof(struct mgio_cg_point_seq))) #define MGIO_CG_ELEMENT_SIZE (MGIO_PARFILE ? (sizeof(MGIO_CG_ELEMENT)) : (sizeof(struct mgio_cg_element_seq))) #define MGIO_REFINEMENT_PS(r,n) (MGIO_PARFILE ? ((r)+(n)) : ((MGIO_REFINEMENT*)(((struct mgio_refinement_seq*)(r))+(n)))) #define MGIO_CG_POINT_PS(p,n) (MGIO_PARFILE ? ((p)+(n)) : ((MGIO_CG_POINT*)(((struct mgio_cg_point_seq*)(p))+(n)))) #define MGIO_CG_ELEMENT_PS(e,n) (MGIO_PARFILE ? ((e)+(n)) : ((MGIO_CG_ELEMENT*)(((struct mgio_cg_element_seq*)(e))+(n)))) #if (MGIO_DIM==2) #define MGIO_CHECKEXTMACROS {assert(MGIO_MAXLEVEL==32); \ assert(MGIO_TAGS==8); \ assert(MGIO_MAX_SONS_OF_ELEM==4); \ assert(MGIO_MAX_EDGES_OF_ELEM==4); \ assert(MGIO_MAX_CORNERS_OF_ELEM==4); \ assert(MGIO_MAX_SIDES_OF_ELEM==4); \ assert(MGIO_MAX_NEW_CORNERS==5); \ assert(MGIO_MAX_CORNERS_OF_SIDE==2);} #endif #if (MGIO_DIM==3) #define MGIO_CHECKEXTMACROS {assert(MGIO_MAXLEVEL==32); \ assert(MGIO_TAGS==8); \ assert(MGIO_MAX_SONS_OF_ELEM==30); \ assert(MGIO_MAX_EDGES_OF_ELEM==12); \ assert(MGIO_MAX_CORNERS_OF_ELEM==8); \ assert(MGIO_MAX_SIDES_OF_ELEM==6); \ assert(MGIO_MAX_NEW_CORNERS==19); \ assert(MGIO_MAX_CORNERS_OF_SIDE==4);} #endif #else #define MGIO_DEBUG 0 /* DO NOT TOUCH !!!!! */ #define MGIO_PAR 0 #define MGIO_MAXLEVEL 32 #define MGIO_TAGS 8 #if (MGIO_DIM==2) #define MGIO_MAX_SONS_OF_ELEM 30 #define MGIO_MAX_EDGES_OF_ELEM 12 #define MGIO_MAX_CORNERS_OF_ELEM 8 #define MGIO_MAX_SIDES_OF_ELEM 6 #define MGIO_MAX_NEW_CORNERS 5 #define MGIO_MAX_CORNERS_OF_SIDE 4 #endif #if (MGIO_DIM==3) #define MGIO_MAX_SONS_OF_ELEM 30 #define MGIO_MAX_EDGES_OF_ELEM 12 #define MGIO_MAX_CORNERS_OF_ELEM 8 #define MGIO_MAX_SIDES_OF_ELEM 6 #define MGIO_MAX_NEW_CORNERS 19 #define MGIO_MAX_CORNERS_OF_SIDE 4 #endif #endif /* defines for MGIO_MG_GENERAL */ #define MGIO_NAMELEN 128 #define MGIO_IDENTLEN 4096 #define MGIO_NODEVECTOR 1 #define MGIO_EDGEVECTOR 2 #define MGIO_SIDEVECTOR 4 #define MGIO_ELEMVECTOR 8 /* macros for MGIO_MG_GENERAL */ #define MGIO_SET_VECTYPE(p,i) (p)->VectorTypes=(i) #define MGIO_ADD_VECTYPE(p,i) (p)->VectorTypes|=(i) #define MGIO_IS_VECTYPE(p,i) (p)->VectorTypes==(i) #define MGIO_CONT_VECTYPE(p,i) (p)->VectorTypes&(i) /****************************************************************************/ /* */ /* data structures exported by the corresponding source file */ /* */ /****************************************************************************/ struct mgio_mg_general { /* information about the file */ int mode; /* macros see above */ char version[MGIO_NAMELEN]; /* version of i/o */ int magic_cookie; /* identification number */ char ident[MGIO_IDENTLEN]; /* identification string from input file */ /* parallel part */ int nparfiles; /* number of processors */ int me; /* id of my processor */ /* number of objects */ int nLevel; /* nb of levels of the mg */ int nNode; /* nb of nodes, i.e. corners of elements */ int nPoint; /* nb of points, i.e. diff node locations in mg */ int nElement; /* nb of elements in mg */ /* information on geometry */ int dim; /* dimension */ char DomainName[MGIO_NAMELEN]; /* name of domain in ug */ char MultiGridName[MGIO_NAMELEN]; /* name of multigrid */ /* information on algebraic structure */ char Formatname[MGIO_NAMELEN]; /* name of format used in ug */ int heapsize; /* heapsize in kbyte, used in ug */ int VectorTypes; /* macros see above */ }; struct mgio_ge_general { int nGenElement; /* nb of general elements used */ }; struct mgio_ge_element { int tag; /* identification of general element in ug */ int nCorner; /* nb of corners */ int nEdge; /* nb of edges */ int nSide; /* nb of sides */ int CornerOfEdge[MGIO_MAX_EDGES_OF_ELEM][2]; /* corners of edge */ int CornerOfSide[MGIO_MAX_SIDES_OF_ELEM][4]; /* corners of side */ }; struct mgio_rr_general { int nRules; /* nb of rules used */ int RefRuleOffset[MGIO_TAGS]; /* offsets used in ug */ }; struct mgio_sondata { SHORT tag; /* which element type is the son */ SHORT corners[MGIO_MAX_CORNERS_OF_ELEM]; /* corners of the son */ SHORT nb[MGIO_MAX_SIDES_OF_ELEM]; /* neighbors of this son */ /* < 20 if neighbor has same father */ /* >= 20 if neighbor has other father */ INT path; /* path used in GetSons() for ug */ }; struct mgio_rr_rule { int rclass; /* class of rule:3bits for COPY, IREG, REG */ int nsons; /* number of sons rule creates */ int pattern[MGIO_MAX_NEW_CORNERS]; /* stores which edges are refined */ int sonandnode[MGIO_MAX_NEW_CORNERS][2]; /* for each new node the number of the son */ /* and the local node number of the node */ struct mgio_sondata sons[MGIO_MAX_SONS_OF_ELEM]; /* for all new sons */ }; struct mgio_cg_general { int nPoint; /* nb of points on coarse grid, sum of next two */ int nBndPoint; /* nb of bnd points on coarse grid */ int nInnerPoint; /* nb of inner points on coarse grid */ int nElement; /* nb of elements on coarse grid, sum of next two */ int nBndElement; /* nb of bnd elements on coarse grid */ int nInnerElement; /* nb of inner elements on coarse grid */ }; struct mgio_cg_point_seq { double position[MGIO_DIM]; /* position of the point */ }; struct mgio_cg_point { double position[MGIO_DIM]; /* position of the point */ int level; /* level of creation */ int prio; /* priority */ }; struct mgio_movedcorner { int id; /* local id of moved node */ double position[MGIO_DIM]; /* position of the point */ }; struct mgio_parinfo { unsigned short *proclist; /* NULL for elements without copies */ unsigned short prio_elem; unsigned short ncopies_elem; int e_ident; /* identification of element */ unsigned short prio_node[MGIO_MAX_CORNERS_OF_ELEM]; unsigned short ncopies_node[MGIO_MAX_CORNERS_OF_ELEM]; int n_ident[MGIO_MAX_CORNERS_OF_ELEM]; /* identification of nodes of elem */ unsigned short prio_vertex[MGIO_MAX_CORNERS_OF_ELEM]; unsigned short ncopies_vertex[MGIO_MAX_CORNERS_OF_ELEM]; int v_ident[MGIO_MAX_CORNERS_OF_ELEM]; /* identification of vertices of elem */ unsigned short prio_edge[MGIO_MAX_EDGES_OF_ELEM]; unsigned short ncopies_edge[MGIO_MAX_EDGES_OF_ELEM]; int ed_ident[MGIO_MAX_EDGES_OF_ELEM]; /* identification of edges of element */ }; struct mgio_cg_element_seq { int ge; /* id of general element */ int cornerid[MGIO_MAX_CORNERS_OF_ELEM]; /* ids of nodes (data reference) */ int nbid[MGIO_MAX_SIDES_OF_ELEM]; /* ids of neighbor elements */ int se_on_bnd; /* side/edge lies on bnd (used bitwise) */ int nref; /* nb of refinements for this element */ /* if 0 element not refined */ int subdomain; /* id of subdomain */ #if (MGIO_DEBUG>0) /* debug extension */ int mykey; /* keys of mine */ int nodekey[MGIO_MAX_CORNERS_OF_ELEM]; /* keys of nodes */ int neighborkey[MGIO_MAX_SIDES_OF_ELEM]; /* keys of neighbors */ #endif }; struct mgio_cg_element { int ge; /* id of general element */ int cornerid[MGIO_MAX_CORNERS_OF_ELEM]; /* ids of nodes (data reference) */ int nbid[MGIO_MAX_SIDES_OF_ELEM]; /* ids of neighbor elements */ int se_on_bnd; /* side/edge lies on bnd (used bitwise) */ int nref; /* nb of refinements for this element */ /* if 0 element not refined */ int subdomain; /* id of subdomain */ #if (MGIO_DEBUG>0) /* debug extension */ int mykey; /* keys of mine */ int nodekey[MGIO_MAX_CORNERS_OF_ELEM]; /* keys of nodes */ int neighborkey[MGIO_MAX_SIDES_OF_ELEM]; /* keys of neighbors */ #endif /* (procs>1)-extension */ int level; }; struct mgio_refinement_seq { /* used only for sizeof */ int refrule; /* id of refinement rule */ int sonref; /* 1 if sons are refined, bitwise */ int refclass; /* refinement class */ int nnewcorners; /* nb of new corners on next level */ int newcornerid[MGIO_MAX_CORNERS_OF_ELEM+MGIO_MAX_NEW_CORNERS]; /* ids of new vert.or -1 */ int nmoved; /* nmoved new vertices moved */ struct mgio_movedcorner mvcorner[MGIO_MAX_NEW_CORNERS]; /* array of moved node */ }; struct mgio_refinement { int refrule; /* id of refinement rule */ int sonref; /* 1 if sons are refined, bitwise */ int refclass; /* refinement class */ int nnewcorners; /* nb of new corners on next level */ int newcornerid[MGIO_MAX_CORNERS_OF_ELEM+MGIO_MAX_NEW_CORNERS]; /* ids of new vert.or -1 */ int nmoved; /* nmoved new vertices moved */ struct mgio_movedcorner mvcorner[MGIO_MAX_NEW_CORNERS]; /* array of moved node */ /* (procs>1)-extension */ int sonex; /* used bitwise */ int orphanid_ex; /* 1 if exists */ int orphanid[MGIO_MAX_CORNERS_OF_ELEM+MGIO_MAX_NEW_CORNERS]; /* ids of orphan node or -1 */ int nbid_ex; /* used bitwise: nbid exists for son ... */ int nbid[MGIO_MAX_SONS_OF_ELEM][MGIO_MAX_SIDES_OF_ELEM]; /* nb-elem-ids of non-orphan */ /* elems referring to orphan elems if nec. */ struct mgio_parinfo pinfo[MGIO_MAX_SONS_OF_ELEM]; #if (MGIO_DEBUG>0) /* debug extension */ int mykey; /* key of the element itself */ int myfatherkey; /* keys of my father */ int mycorners; /* number of element corners */ int mycornerkey[MGIO_MAX_CORNERS_OF_ELEM]; /* keys of the element's corners */ int mycornerfatherkey[MGIO_MAX_CORNERS_OF_ELEM]; /* keys of the element's corners fathers*/ int mycornersonkey[MGIO_MAX_CORNERS_OF_ELEM]; /* keys of the element's corners sons*/ int nbkey[MGIO_MAX_SIDES_OF_ELEM]; /* nb-elem-keys element */ /* (procs>1)-extension */ int sonskey[MGIO_MAX_SONS_OF_ELEM]; /* keys of sons of element */ int sonsnbkey[MGIO_MAX_SONS_OF_ELEM][MGIO_MAX_SIDES_OF_ELEM]; /* keys of neighbors of sons of element */ #endif }; struct mgio_bd_general { int nBndP; /* n BNDP in mg, only ug */ }; typedef struct mgio_mg_general MGIO_MG_GENERAL; typedef struct mgio_ge_general MGIO_GE_GENERAL; typedef struct mgio_ge_element MGIO_GE_ELEMENT; typedef struct mgio_rr_general MGIO_RR_GENERAL; typedef struct mgio_rr_rule MGIO_RR_RULE; typedef struct mgio_cg_general MGIO_CG_GENERAL; typedef struct mgio_cg_point MGIO_CG_POINT; typedef struct mgio_cg_element MGIO_CG_ELEMENT; typedef struct mgio_refinement MGIO_REFINEMENT; typedef struct mgio_bd_general MGIO_BD_GENERAL; typedef struct mgio_parinfo MGIO_PARINFO; /****************************************************************************/ /* */ /* definition of exported global variables */ /* */ /****************************************************************************/ extern int mgpathes_set; /****************************************************************************/ /* */ /* function declarations */ /* */ /****************************************************************************/ /* read functions */ int Read_OpenMGFile (char *filename); int Read_MG_General (MGIO_MG_GENERAL *mg_general); int Read_GE_General (MGIO_GE_GENERAL *ge_general); int Read_GE_Elements (int n, MGIO_GE_ELEMENT *ge_element); int Read_RR_General (MGIO_RR_GENERAL *rr_general); int Read_RR_Rules (int n, MGIO_RR_RULE *rr_rules); int Read_CG_General (MGIO_CG_GENERAL *cg_general); int Read_CG_Points (int n, MGIO_CG_POINT *cg_point); int Read_CG_Elements (int n, MGIO_CG_ELEMENT *cg_element); int Read_Refinement (MGIO_REFINEMENT *refinement, MGIO_RR_RULE *rr_rules); int Read_BD_General (MGIO_BD_GENERAL *bd_general); /* write functions */ int Write_OpenMGFile (char *filename, int rename); int Write_MG_General (MGIO_MG_GENERAL *mg_general); int Write_GE_General (MGIO_GE_GENERAL *ge_general); int Write_GE_Elements (int n, MGIO_GE_ELEMENT *ge_element); int Write_RR_General (MGIO_RR_GENERAL *rr_general); int Write_RR_Rules (int n, MGIO_RR_RULE *rr_rules); int Write_CG_General (MGIO_CG_GENERAL *cg_general); int Write_CG_Points (int n, MGIO_CG_POINT *cg_point); int Write_CG_Elements (int n, MGIO_CG_ELEMENT *cg_element); int Write_Refinement (MGIO_REFINEMENT *refinement, MGIO_RR_RULE *rr_rules); int Write_BD_General (MGIO_BD_GENERAL *bd_general); #ifdef __MGIO_USE_IN_UG__ int Read_pinfo (int ge, MGIO_PARINFO *pinfo); int Write_pinfo (int ge, MGIO_PARINFO *pinfo); int MGIO_filetype (char *filename); int Read_PBndDesc (STD_BVP *theBVP, NS_PREFIX HEAP *theHeap, int n, BNDP **BndPList); int Write_PBndDesc (int n, BNDP **BndPList); #endif /* general functions */ int CloseMGFile (void); int MGIO_Init (void); int MGIO_dircreate (char *filename, int rename); END_UGDIM_NAMESPACE #endif