LORENE
app_hor.h
1 /*
2  * Definition of Lorene class App_hor
3  *
4  */
5 
6 /*
7  * Copyright (c) 2005 Lap-Ming Lin & Jerome Novak
8  *
9  *
10  * This file is part of LORENE.
11  *
12  * LORENE is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License version 2
14  * as published by the Free Software Foundation.
15  *
16  * LORENE is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with LORENE; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24  *
25  */
26 
27 #ifndef __APP_HOR_H_
28 #define __APP_HOR_H_
29 
30 /*
31  * $Id: app_hor.h,v 1.7 2022/09/30 14:41:38 j_novak Exp $
32  * $Log: app_hor.h,v $
33  * Revision 1.7 2022/09/30 14:41:38 j_novak
34  * Corrected comments.
35  *
36  * Revision 1.6 2014/10/13 08:52:31 j_novak
37  * Lorene classes and functions now belong to the namespace Lorene.
38  *
39  * Revision 1.5 2012/01/02 13:52:57 j_novak
40  * New parameter 'verbose' to get less output if needed.
41  *
42  * Revision 1.4 2005/12/09 09:35:59 lm_lin
43  *
44  * Minor fix in the documentation.
45  *
46  * Revision 1.3 2005/12/07 11:11:30 lm_lin
47  *
48  * Add option to turn off screen output during iterations.
49  *
50  * Revision 1.2 2005/11/17 14:19:49 lm_lin
51  *
52  * Check the expansion function evaluated on the apparent horizon after the
53  * iteration of the 2-surface converges.
54  *
55  * Revision 1.1 2005/10/13 08:51:14 j_novak
56  * New stuff for apparent horizon finder. For the moment, there is only an
57  * external function. A class should come soon...
58  *
59  * $Header: /cvsroot/Lorene/C++/Include/app_hor.h,v 1.7 2022/09/30 14:41:38 j_novak Exp $
60  *
61  */
62 
63 
64 // Headers Lorene
65 #include "metric.h"
66 
67 namespace Lorene {
73  // Function (Apparent horizon finder)
74  //-----------------------------------------------
75 
124 bool ah_finder(const Metric& gamma, const Sym_tensor& k_dd_in, Valeur& h, Scalar& ex_fcn,
125  double a_axis, double b_axis, double c_axis, bool verbose = true,
126  bool print = false, double precis = 1.e-8, double precis_exp = 1.e-6,
127  int it_max = 200, int it_relax = 200, double relax_fac = 1.) ;
128 
129 }
130 #endif
Metric for tensor calculation.
Definition: metric.h:90
Lorene prototypes.
Definition: app_hor.h:67
Tensor field of valence 0 (or component of a tensorial field).
Definition: scalar.h:393
bool ah_finder(const Metric &gamma, const Sym_tensor &k_dd_in, Valeur &h, Scalar &ex_fcn, double a_axis, double b_axis, double c_axis, bool verbose=true, bool print=false, double precis=1.e-8, double precis_exp=1.e-6, int it_max=200, int it_relax=200, double relax_fac=1.)
Apparent horizon linked functions.
Values and coefficients of a (real-value) function.
Definition: valeur.h:297
Class intended to describe valence-2 symmetric tensors.
Definition: sym_tensor.h:226