MOAB: Mesh Oriented datABase  (version 5.2.1)
CompositeOFAdd.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     diachin2@llnl.gov, djmelan@sandia.gov, mbrewer@sandia.gov,
00024     pknupp@sandia.gov, tleurent@mcs.anl.gov, tmunson@mcs.anl.gov
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 CompositeOFAdd.hpp
00031 
00032 Header file for the MBMesquite:: CompositeOFAdd class
00033 
00034   \author Michael Brewer
00035   \date   2002-06-24
00036  */
00037 
00038 #ifndef CompositeOFAdd_hpp
00039 #define CompositeOFAdd_hpp
00040 
00041 #include "Mesquite.hpp"
00042 #include "ObjectiveFunction.hpp"
00043 #include "MsqHessian.hpp"
00044 
00045 namespace MBMesquite
00046 {
00047 /*!\class CompositeOFAdd
00048   \brief Adds two ObjectiveFunction values together.
00049 */
00050 class MsqMeshEntity;
00051 class PatchData;
00052 class MsqError;
00053 class Vector3D;
00054 
00055 class CompositeOFAdd : public ObjectiveFunction
00056 {
00057   public:
00058     MESQUITE_EXPORT
00059     CompositeOFAdd( ObjectiveFunction*, ObjectiveFunction*, bool delete_OFs = false );
00060 
00061     MESQUITE_EXPORT
00062     virtual ~CompositeOFAdd();
00063 
00064     //!\brief Called at start of instruction queue processing
00065     //!
00066     //! Do any preliminary global initialization, consistency checking,
00067     //! etc.
00068     MESQUITE_EXPORT
00069     virtual void initialize_queue( MeshDomainAssoc* mesh_and_domain, const Settings* settings, MsqError& err );
00070 
00071     MESQUITE_EXPORT
00072     virtual bool initialize_block_coordinate_descent( MeshDomainAssoc* mesh_and_domain, const Settings* settings,
00073                                                       PatchSet* user_set, MsqError& err );
00074 
00075     MESQUITE_EXPORT
00076     virtual bool evaluate( EvalType type, PatchData& pd, double& value_out, bool free, MsqError& err );
00077 
00078     MESQUITE_EXPORT
00079     virtual bool evaluate_with_gradient( EvalType type, PatchData& pd, double& value_out,
00080                                          std::vector< Vector3D >& grad_out, MsqError& err );
00081 
00082     MESQUITE_EXPORT
00083     virtual bool evaluate_with_Hessian_diagonal( EvalType type, PatchData& pd, double& value_out,
00084                                                  std::vector< Vector3D >& grad_out,
00085                                                  std::vector< SymMatrix3D >& hess_diag_out, MsqError& err );
00086 
00087     MESQUITE_EXPORT
00088     virtual bool evaluate_with_Hessian( EvalType type, PatchData& pd, double& value_out,
00089                                         std::vector< Vector3D >& grad_out, MsqHessian& Hessian_out, MsqError& err );
00090 
00091     MESQUITE_EXPORT
00092     virtual ObjectiveFunction* clone() const;
00093 
00094     MESQUITE_EXPORT
00095     virtual void clear();
00096 
00097     MESQUITE_EXPORT
00098     virtual int min_patch_layers() const;
00099 
00100   private:
00101     /** Temporary storage for gradient */
00102     mutable std::vector< Vector3D > mGradient;
00103     /** Temporary storage for hessian diagonal */
00104     mutable std::vector< SymMatrix3D > mDiagonal;
00105     /** Temporary storage for Hessian */
00106     mutable MsqHessian mHessian;
00107 
00108     ObjectiveFunction* objFunc1;
00109     ObjectiveFunction* objFunc2;
00110     bool deleteObjFuncs;
00111 };
00112 }  // namespace MBMesquite
00113 #endif  //  CompositeOFAdd_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines