Points&Forces (survey)
Software tools facilitating the task of surveying architecture
a_fcriteria.cxx
Go to the documentation of this file.
1 /*
2 Copyright 2016 Pierre SMARS (smars@yuntech.edu.tw)
3 This program is free software: you can redistribute it and/or modify
4 it under the terms of the GNU General Public License as published by
5 the Free Software Foundation, either version 2 of the License, or
6 (at your option) any later version.
7 
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
12 
13 You should have received a copy of the GNU General Public License
14 along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16 #include "a_fcriteria.h"
17 #include <iostream>
18 #include <sstream>
19 #include "config.h"
20 
21 //---------------------------------------------------------------------------
22 const std::string a_fcriteria::help()
23 {
24  std::ostringstream o;
25  o << "************" << std::endl;
26  o << "a_fcriteria:" << std::endl;
27  o << "************" << std::endl;
28  o << "This class implement a resistance criterion to be assigned to face(s) of block(s) of a structure" << std::endl;
29  o << "ok 'a_face': return true if forces on the face are acceptable" << std::endl;
30  o << "verysmall: return small value used for calculation (default: 1.e-6)" << std::endl;
31  o << "verysmall 'val': set small value used for calculation" << std::endl;
32  o << "penalty 'a_face': return the penalty value of a face (0 if ok)" << std::endl;
33  o << "" << std::endl;
34  o << "This specific class is a parent class," << std::endl;
35  o << "it always returns ok, it has to be overriden to produce interesting results" << std::endl;
36  return o.str();
37 }
static const std::string help()
get information about the class
Definition: a_fcriteria.cxx:22