---

results_domain.h File Reference

Manage interaction with result object that can read and write domain files. More...

#include "resultlib_domain.h"
#include "resultlib/results.h"

Functions
ExportedByResultlib_domain RFInterface*	rfmi_open_domain (size_t nf, char **files, char* be, int np, char** pars, int force, RFMeshInterface *mi)
	Open specified result files and return result interface object representing specified backend. More...
ExportedByResultlib_domain RFInterface*	rfmi_restricted_domain (size_t nf, char **files, int npars, char ** pars, rfobj_impl *rfobj, RFMeshInterface *mi, int iNAllowTypes, const int *iAllowTypes)
	Create an interface to a restricted domain file. More...
ExportedByResultlib_domain RFInterface*	rfmi_rfinfodomain_factory ()
	Create a rfinfo_domain implementation of rf_backend_interface for a front end application. More...
ExportedByResultlib_domain RFInterface*	rfmi_empty_domain (RFMeshInterface *mi)
	Use rfmi_rfinfodomain_factory() to create a rfinfo_domain implementation object. More...
ExportedByResultlib_domain int	rf_write_domain (RFInterface *info, char *file, int n_res_given, rf_result_func grs, int tstep, void *auxdata)
	Write the current mesh and results managed by info into a domain file. More...
ExportedByResultlib_domain int	rf_write_domain_results_from (RFInterface *info, RFInterface *results_from_info, char* file, int tstep)
	Write the mesh managed by info and results managed results_from_info into a domain file. More...

---

Detailed Description

Manage interaction with result object that can read and write domain files.

Copyright (c) 2002 ICEM CFD Engineering A subsidary of ANSYS INC.

Author(s):

Forest Rouse.

Revision: 1.9

on

Date: 2005/01/18 00:39:05

Source: /home/josie/cvs/resultlib_domain/results_domain.h,v

---

Function Documentation

ExportedByResultlib_domain RFInterface * rfmi_open_domain ( size_t nf, char ** files, char * be, int np, char ** pars, int force, RFMeshInterface * mi )

Open specified result files and return result interface object representing specified backend. Use the rfinfo_domain as the underlying result library object to handle mesh. This allows reading and writing of ICEM CFD domain files. See also: rfmi_open_multi(). Parameters: nf   number of files to open. files   name of files to open and read. be   name of reader backend to create. np   number of command line arguments for backend. pars   parameter names and values for backend. force   force flag. Force the use of external reader. mi   mesh interface implementation. Use 0 for default (openMesh). Returns: result interface object. Examples: GatewayTest.C.

ExportedByResultlib_domain RFInterface * rfmi_restricted_domain ( size_t nf, char ** files, int npars, char ** pars, rfobj_impl * rfobj, RFMeshInterface * mi, int iNAllowTypes, const int * iAllowTypes )

Create an interface to a restricted domain file. A restricted domain file only has a specified allowed list of element types that it will read. Parameters: nf   number of files to open. files   name of files to open and read. np   number of command line arguments for backend. pars   parameter names and values for backend. rfobj   option implemention object. If not specifed, will use rfinfo_domain. mi   mesh interface implementation. Use 0 for default (openMesh). iNAllowTypes   number of element types to allow read. iAllowTypes   list of allowed types. Returns: result interface object.

ExportedByResultlib_domain RFInterface * rfmi_rfinfodomain_factory ( )

Create a rfinfo_domain implementation of rf_backend_interface for a front end application. User is returned a result interface object. Users can then edit the object as desired using the standard result interface. See also: rfmi_open_domain() , rfmi_empty_domain() Returns: result interface object.

ExportedByResultlib_domain RFInterface * rfmi_empty_domain ( RFMeshInterface * mi )

Use rfmi_rfinfodomain_factory() to create a rfinfo_domain implementation object. See also: rfmi_rfinfodomain_factory() , rfmi_open_domain() Parameters: mi   mesh interface implementation to use. If 0, defaults to openMesh. Returns: result interface object. Examples: example_struct.cxx, and example_uns.cxx.

ExportedByResultlib_domain int rf_write_domain ( RFInterface * info, char * file, int n_res_given, rf_result_func grs, int tstep, void * auxdata )

Write the current mesh and results managed by info into a domain file. Parameters: info   result interface. file   file name to write. n_res_given   number of results to handle. If < 0, use the number of results recorded. get_res_func   result callback function. Users can specify this function to describe and report results to be written out to the domain file. If no result function given, the default function will write out raw data from the backend only. tstep   time step to write. auxdata   anonymous user data passed to the result callback function. Returns: 1 = success, 0 = failure. Examples: example_struct.cxx, and example_uns.cxx.

ExportedByResultlib_domain int rf_write_domain_results_from ( RFInterface * info, RFInterface * results_from_info, char * file, int tstep )

Write the mesh managed by info and results managed results_from_info into a domain file. Just writes raw data. See also: rf_write_domain() Parameters: info   result interface for mesh. results_from_info   result interface for results. file   file name to write. tstep   time step to write. Returns: 1 = success, 0 = failure.

---