ascend4/solver/bndman.h

/*
 *  Boundary Manipulator Module
 *  Created: 04/97
 *  Version: $Revision: 1.6 $
 *  Version control file: $RCSfile: bndman.h,v $
 *  Date last modified: $Date: 1997/07/18 12:13:58 $
 *  Last modified by: $Author: mthomas $
 *
 *  This file is part of the SLV solver.
 *
 *  The SLV solver is free software; you can redistribute
 *  it and/or modify it under the terms of the GNU General Public License as
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version.
 *
 *  The SLV solver is distributed in hope that it will be
 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with the program; if not, write to the Free Software Foundation,
 *  Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check the file named
 *  COPYING.  COPYING is found in ../compiler.
 *
 */


/*
 *  Contents:     Boundary manipulator module
 *
 *  Dates:        04/97 - original version
 * 
 *  Description:  This module will provide supplemental operations for
 *                boundaries such as evaluation.
 */

#ifndef bndman__already_included
#define bndman__already_included

extern real64 bndman_real_eval(struct bnd_boundary *);
extern int32  bndman_log_eval(struct bnd_boundary *);
/*
 *  value = bndman_real_eval(bnd)
 *  logvalue = bndman_log_eval(bnd)
 *  real64 value;
 *  int32 logvalue;
 *  struct bnd_boundary *bnd;
 *
 *  Returns the (real/boolean) residual of the boundary.
 */

extern int32 bndman_calc_satisfied(struct bnd_boundary *);
/*
 *  value = bndman_calc_satisfied(bnd);
 *  int32 value;
 *  struct bnd_boundary *bnd;
 *
 *  Returns whether the boundary is currently satisfied based on its
 *  calculated residual.
 */

extern int32 bndman_calc_at_zero(struct bnd_boundary *);
/*
 *  value = bndman_calc_at_zero(bnd);
 *  int32 value;
 *  struct bnd_boundary *bnd;
 *
 *  Returns whether the current point lies at the zero of a boundary
 *  based on the calculation of the residual of the boundary
 *  Used only for real(not boolean) boundaries.
 */

#endif  /* bndman__already_included */
1	/*
2	* Boundary Manipulator Module
3	* Created: 04/97
4	* Version: $Revision: 1.6 $
5	* Version control file: $RCSfile: bndman.h,v $
6	* Date last modified: $Date: 1997/07/18 12:13:58 $
7	* Last modified by: $Author: mthomas $
8	*
9	* This file is part of the SLV solver.
10	*
11	* The SLV solver is free software; you can redistribute
12	* it and/or modify it under the terms of the GNU General Public License as
13	* published by the Free Software Foundation; either version 2 of the
14	* License, or (at your option) any later version.
15	*
16	* The SLV solver is distributed in hope that it will be
17	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19	* General Public License for more details.
20	*
21	* You should have received a copy of the GNU General Public License
22	* along with the program; if not, write to the Free Software Foundation,
23	* Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
24	* COPYING. COPYING is found in ../compiler.
25	*
26	*/
27
28
29	/*
30	* Contents: Boundary manipulator module
31	*
32	* Dates: 04/97 - original version
33	*
34	* Description: This module will provide supplemental operations for
35	* boundaries such as evaluation.
36	*/
37
38	#ifndef bndman__already_included
39	#define bndman__already_included
40
41	extern real64 bndman_real_eval(struct bnd_boundary *);
42	extern int32 bndman_log_eval(struct bnd_boundary *);
43	/*
44	* value = bndman_real_eval(bnd)
45	* logvalue = bndman_log_eval(bnd)
46	* real64 value;
47	* int32 logvalue;
48	* struct bnd_boundary *bnd;
49	*
50	* Returns the (real/boolean) residual of the boundary.
51	*/
52
53	extern int32 bndman_calc_satisfied(struct bnd_boundary *);
54	/*
55	* value = bndman_calc_satisfied(bnd);
56	* int32 value;
57	* struct bnd_boundary *bnd;
58	*
59	* Returns whether the boundary is currently satisfied based on its
60	* calculated residual.
61	*/
62
63	extern int32 bndman_calc_at_zero(struct bnd_boundary *);
64	/*
65	* value = bndman_calc_at_zero(bnd);
66	* int32 value;
67	* struct bnd_boundary *bnd;
68	*
69	* Returns whether the current point lies at the zero of a boundary
70	* based on the calculation of the residual of the boundary
71	* Used only for real(not boolean) boundaries.
72	*/
73
74	#endif /* bndman__already_included */