Main Page   Modules   Compound List   File List   File Members  

Important APIs


Files

file  Gnuplot.h
 This file documents the APIs for writing grid in Gnuplot compatible output.

file  Tecplot.h
 This file documents the APIs for writing grid in Tecplot compatible output.


Functions

void get_cell_edges (struct Edge ***cell_ed, int *num_ed, struct Cell *cl)
 get_cell_edges

void get_cell_vertices (struct Vertex ***cell_vt, int *num_vt, struct Cell *cl)
 get_cell_vertices

int get_face_normal_sign (struct Face *fc, struct Cell *cl)
 get_face_normal_sign

void domain_init (int cl_num, int fc_num, int ed_num, int vt_num, const char *file, struct Domain *dmn)
 domain_init

void find_face_cell_mapping (struct Domain *dmn)
 find_face_cell_mapping

void find_edge_face_mapping (struct Domain *dmn)
 find_edge_face_mapping

void find_vertex_vertex_mapping (struct Domain *dmn)
 find_vertex_vertex_mapping

void find_vertex_edge_mapping (struct Domain *dmn)
 find_vertex_edge_mapping

void output_domain (FILE *fp, struct Domain *dmn)
 output_domain

void serialize_domain (FILE *fp, struct Domain *dmn)
 output_domain

void domain_destroy (struct Domain *dmn)
 domain_destroy

void add_cell (int global_num, int *face_num_array, int fc_num, struct Domain *domain)
 add_cell

void add_face (int global_num, int *edge_num_array, int ed_num, struct Domain *domain)
 add_face

void add_edge (int global_num, int vertex_nums[2], struct Domain *domain)
 add_edge

void add_vertex (int global_num, float *coordinates, struct Domain *domain)
 add_vertex

void input_complete (struct Domain *domain)
 imput_complete

void specify_file_reader (FILE_READER_PTR f_reader)
 specify_file_reader

void writeGnuplotGrid (struct Domain *dmn, float cutting_plane[4], char *outputFile)
 writeGnuplotGrid

short face_cut_by_plane (struct Face *fc, float cutting_plane[4])
 writeTecplotGrid


Detailed Description

Documentation of important APIs.

Function Documentation

void add_cell int    global_num,
int *    face_num_array,
int    fc_num,
struct Domain   domain
 

add_cell

This method adds a cell to the domain, given its global number, an array of global face numbers that form this cell, number of faces in the cell (fc_num), and a pointer to Domain object.

void add_edge int    global_num,
int    vertex_nums[2],
struct Domain   domain
 

add_edge

This method adds an edge to the domain, given its global number, global number of its two vertices, and a pointer to the Domain object.

void add_face int    global_num,
int *    edge_num_array,
int    ed_num,
struct Domain   domain
 

add_face

This method adds a face to the domain, given its global number, an array of global edge numbers that form this face, number of edges in the face (ed_num), and a pointer to Domain object.

void add_vertex int    global_num,
float *    coordinates,
struct Domain   domain
 

add_vertex

This method adds a vertex to the domain, given its global number, an array of three coordinates (x, y, z), and a pointer to the Domain object.

void domain_destroy struct Domain   dmn
 

domain_destroy

Works akin to C++ destructor. Invoke this on Domain object, it will take care of deallocating all its variables, datastructures.

void domain_init int    cl_num,
int    fc_num,
int    ed_num,
int    vt_num,
const char *    file,
struct Domain   dmn
 

domain_init

This method allocates space for Domain object dmn. It needs number of cells, faces, edges and vertices in the grid, and the grid file. The grid file is read by the file_reader, which may be specified using , or the dafult file reader (if none is specified)

short face_cut_by_plane struct Face   fc,
float    cutting_plane[4]
 

writeTecplotGrid

Call this method to produce a Tecplot viewable file. Provide the pointer to Domain object (whose grid needs to be plotted), cutting plane, and output file name. cutting_plane cuts the grid across a specified plane and shows only the faces cut by the plane. cutting_plane is the equation of plane that cuts the domain. Elements in this array represent coefficients in the following order: cutting_plane = {a, b, c, d}; aX + bY + cZ + d = 0

void find_edge_face_mapping struct Domain   dmn
 

find_edge_face_mapping

This method finds edge to adjoining face mapping.

void find_face_cell_mapping struct Domain   dmn
 

find_face_cell_mapping

This method finds face to adjoining cell mapping.

void find_vertex_edge_mapping struct Domain   dmn
 

find_vertex_edge_mapping

This method finds vertex to adjoining edge mapping.

void find_vertex_vertex_mapping struct Domain   dmn
 

find_vertex_vertex_mapping

This method finds vertex to adjoining vertices mapping.

void get_cell_edges struct Edge ***    cell_ed,
int *    num_ed,
struct Cell   cl
 

get_cell_edges

This method finds the edges forming a cell and returns the array as a pointer, cell_ed. cell_ed is the array of pointers to Edge s forming the Cell cl. cell_ed should be null, the function will make it point to the right array upon completion. num_ed is the number of edges in this array (returned from this function). It is an int*.

void get_cell_vertices struct Vertex ***    cell_vt,
int *    num_vt,
struct Cell   cl
 

get_cell_vertices

This method finds the vertices forming a cell and returns the array as a pointer, cell_vt. cell_vt is the array of pointers to Vertex s forming the Cell cl. cell_vt should be null, the function will make it point to the right array upon completion. num_vt is the number of vertices in this array (returned from this function). It is an int*.

int get_face_normal_sign struct Face   fc,
struct Cell   cl
 

get_face_normal_sign

This method returns a flag indicating how to obtain the unit outward normal for a face with respect to a cell, from the face normal. +1 indicates the face normal is the outward normal, 0 indicates its sign must be reversed.

void input_complete struct Domain   domain
 

imput_complete

Call this method once the grid input (defining cells, faces, edges and vertices) is finished. This method marshalls a handful of other APIs to properly populate all data structures.

void output_domain FILE *    fp,
struct Domain   dmn
 

output_domain

This method outputs the domain object in default IO format.

void serialize_domain FILE *    fp,
struct Domain   dmn
 

output_domain

This method serializes the domain object (serializes).

void specify_file_reader FILE_READER_PTR    f_reader
 

specify_file_reader

Call this method to submit a new file reader that must be used to process the input data file.

void writeGnuplotGrid struct Domain   dmn,
float    cutting_plane[4],
char *    outputFile
 

writeGnuplotGrid

Call this method to produce a Gnuplot viewable file. Provide the pointer to Domain object (whose grid needs to be plotted), cutting plane, and output file name. cutting_plane cuts the grid across a specified plane and shows only the faces cut by the plane. cutting_plane is the equation of plane that cuts the domain. Elements in this array represent coefficients in the following order: cutting_plane = {a, b, c, d}; aX + bY + cZ + d = 0


Generated on Sun Nov 27 23:41:48 2005 by doxygen1.2.18