Rocstar  1.0
Rocstar multiphysics simulation application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
includeLinks/CompositeOFMultiply.hpp
Go to the documentation of this file.
1 /* *****************************************************************
2  MESQUITE -- The Mesh Quality Improvement Toolkit
3 
4  Copyright 2004 Sandia Corporation and Argonne National
5  Laboratory. Under the terms of Contract DE-AC04-94AL85000
6  with Sandia Corporation, the U.S. Government retains certain
7  rights in this software.
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public License
20  (lgpl.txt) along with this library; if not, write to the Free Software
21  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 
23  diachin2@llnl.gov, djmelan@sandia.gov, mbrewer@sandia.gov,
24  pknupp@sandia.gov, tleurent@mcs.anl.gov, tmunson@mcs.anl.gov
25 
26  ***************************************************************** */
27 // -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3 -*-
28 
38 #ifndef CompositeOFMultiply_hpp
39 #define CompositeOFMultiply_hpp
40 
41 #include "Mesquite.hpp"
42 #include "ObjectiveFunction.hpp"
43 
44 namespace Mesquite
45 {
49  class MsqMeshEntity;
50  class PatchData;
52  {
53  public:
55  virtual ~CompositeOFMultiply();
56  virtual bool concrete_evaluate(PatchData &patch, double &fval,
57  MsqError &err);
58  virtual msq_std::list<QualityMetric*> get_quality_metric_list();
59  protected:
61  bool compute_analytical_gradient(PatchData &patch,Vector3D *const &grad,
62  double &OF_val, MsqError &err,
63  size_t array_size);
64  private:
67  };
68 }//namespace
69 #endif // CompositeOFMultiply_hpp
virtual msq_std::list< QualityMetric * > get_quality_metric_list()
Used to hold the error state and return it to the application.
Multiplies two ObjectiveFunction values together.
Vector3D is the object that effeciently stores information about about three-deminsional vectors...
CompositeOFMultiply(ObjectiveFunction *, ObjectiveFunction *)
Definition: patch.h:74
virtual bool concrete_evaluate(PatchData &patch, double &fval, MsqError &err)
Base class for concrete Objective Functions ObjectiveFunction contains a pointer to a QualityMetric...
bool compute_analytical_gradient(PatchData &patch, Vector3D *const &grad, double &OF_val, MsqError &err, size_t array_size)
Implement the scalar multiply analytic gradient.