MOAB: Mesh Oriented datABase  (version 5.4.1)
CompositeOFMultiply.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2004 Sandia Corporation and Argonne National
00005     Laboratory.  Under the terms of Contract DE-AC04-94AL85000
00006     with Sandia Corporation, the U.S. Government retains certain
00007     rights in this software.
00008 
00009     This library is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU Lesser General Public
00011     License as published by the Free Software Foundation; either
00012     version 2.1 of the License, or (at your option) any later version.
00013 
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Lesser General Public License for more details.
00018 
00019     You should have received a copy of the GNU Lesser General Public License
00020     (lgpl.txt) along with this library; if not, write to the Free Software
00021     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 
00023     [email protected], [email protected], [email protected],
00024     [email protected], [email protected], [email protected]
00025 
00026   ***************************************************************** */
00027 // -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3
00028 // -*-
00029 
00030 /*! \file CompositeOFMultiply.hpp
00031 
00032 Header file for the MBMesquite:: CompositeOFMultiply class
00033 
00034   \author Michael Brewer
00035   \date   2002-05-23
00036  */
00037 
00038 #ifndef CompositeOFMultiply_hpp
00039 #define CompositeOFMultiply_hpp
00040 
00041 #include "Mesquite.hpp"
00042 #include "ObjectiveFunction.hpp"
00043 #include "MsqHessian.hpp"
00044 
00045 namespace MBMesquite
00046 {
00047 /*!\class CompositeOFMultiply
00048     \brief Multiplies two ObjectiveFunction values together.
00049   */
00050 class MsqMeshEntity;
00051 class PatchData;
00052 class CompositeOFMultiply : public ObjectiveFunction
00053 {
00054   public:
00055     MESQUITE_EXPORT
00056     CompositeOFMultiply( ObjectiveFunction*, ObjectiveFunction*, bool delete_OFs = false );
00057     MESQUITE_EXPORT
00058     virtual ~CompositeOFMultiply();
00059 
00060     //!\brief Called at start of instruction queue processing
00061     //!
00062     //! Do any preliminary global initialization, consistency checking,
00063     //! etc.
00064     MESQUITE_EXPORT
00065     virtual void initialize_queue( MeshDomainAssoc* mesh_and_domain, const Settings* settings, MsqError& err );
00066 
00067     MESQUITE_EXPORT
00068     virtual bool initialize_block_coordinate_descent( MeshDomainAssoc* mesh_and_domain,
00069                                                       const Settings* settings,
00070                                                       PatchSet* user_set,
00071                                                       MsqError& err );
00072 
00073     MESQUITE_EXPORT
00074     virtual bool evaluate( EvalType type, PatchData& pd, double& value_out, bool free, MsqError& err );
00075 
00076     MESQUITE_EXPORT
00077     virtual bool evaluate_with_gradient( EvalType type,
00078                                          PatchData& pd,
00079                                          double& value_out,
00080                                          std::vector< Vector3D >& grad_out,
00081                                          MsqError& err );
00082 
00083     MESQUITE_EXPORT
00084     virtual bool evaluate_with_Hessian_diagonal( EvalType type,
00085                                                  PatchData& pd,
00086                                                  double& value_out,
00087                                                  std::vector< Vector3D >& grad_out,
00088                                                  std::vector< SymMatrix3D >& hess_diag_out,
00089                                                  MsqError& err );
00090 
00091     MESQUITE_EXPORT
00092     virtual bool evaluate_with_Hessian( EvalType type,
00093                                         PatchData& pd,
00094                                         double& value_out,
00095                                         std::vector< Vector3D >& grad_out,
00096                                         MsqHessian& Hessian_out,
00097                                         MsqError& err );
00098 
00099     MESQUITE_EXPORT
00100     virtual ObjectiveFunction* clone() const;
00101 
00102     MESQUITE_EXPORT
00103     virtual void clear();
00104 
00105     MESQUITE_EXPORT
00106     virtual int min_patch_layers() const;
00107 
00108   private:
00109     /** Temporary storage for gradient */
00110     mutable std::vector< Vector3D > mGradient;
00111     /** Temporary storage for hessian diagonal */
00112     mutable std::vector< SymMatrix3D > mDiagonal;
00113 
00114     ObjectiveFunction* objFunc1;
00115     ObjectiveFunction* objFunc2;
00116     bool deleteObjFuncs;
00117 };
00118 }  // namespace MBMesquite
00119 #endif  //  CompositeOFMultiply_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines