---

DomainBuilder.h File Reference

This file documents the APIs provided by DomainBuilder. More...

#include "common_headers.h"

Go to the source code of this file.

Functions
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

---

Detailed Description

This file documents the APIs provided by DomainBuilder.

---

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 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 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.

---