GridRegister

 Adds a creation method to the grid package.

Synopsis

#include "grid.h"  
#undef __FUNCT__  
#define __FUNCT__ "GridRegister"
int GridRegister(const char sname[], const char path[], const char name[], int (*function)(Grid))

Synopsis




GridRegister(char *name, char *path, char *func_name, int (*create_func)(Grid))


Not Collective



Input Parameters




name        - The name of a new user-defined creation routine



path        - The path (either absolute or relative) of the library containing this routine



func_name   - The name of the creation routine



create_func - The creation routine itself





Notes

GridRegister() may be called multiple times to add several user-defined grides.


If dynamic libraries are used, then the fourth input argument (create_func) is ignored.



Sample usage


  GridRegisterDynamic("my_grid", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyGridCreate", MyGridCreate);





Then, your grid type can be chosen with the procedural interface via

    GridCreate(MPI_Comm, Grid *);
    GridSetType(vec, "my_grid")



or at runtime via the option

    -grid_type my_grid





Note: $PETSC_ARCH and $BOPT occuring in pathname will be replaced with appropriate values.






Keywords

 Grid, register



See Also

 GridRegisterAll(), GridRegisterDestroy()

Level:advanced

Location:src/grid/interface/gridreg.c

Index of all Grid routines

Table of Contents for all manual pages

Index of all manual pages