00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Sundance 00005 // Copyright 2011 Sandia Corporation 00006 // 00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, 00008 // the U.S. Government retains certain rights in this software. 00009 // 00010 // Redistribution and use in source and binary forms, with or without 00011 // modification, are permitted provided that the following conditions are 00012 // met: 00013 // 00014 // 1. Redistributions of source code must retain the above copyright 00015 // notice, this list of conditions and the following disclaimer. 00016 // 00017 // 2. Redistributions in binary form must reproduce the above copyright 00018 // notice, this list of conditions and the following disclaimer in the 00019 // documentation and/or other materials provided with the distribution. 00020 // 00021 // 3. Neither the name of the Corporation nor the names of the 00022 // contributors may be used to endorse or promote products derived from 00023 // this software without specific prior written permission. 00024 // 00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY 00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE 00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00036 // 00037 // Questions? Contact Kevin Long (kevin.long@ttu.edu) 00038 // 00039 00040 /* @HEADER@ */ 00041 00042 #ifndef SUNDANCE_VECTORCALCULUS_H 00043 #define SUNDANCE_VECTORCALCULUS_H 00044 00045 #include "SundanceExpr.hpp" 00046 00047 namespace Sundance 00048 { 00049 00050 00051 /** \relates Expr */ 00052 Expr gradient(int dim); 00053 00054 /** \relates Expr */ 00055 Expr div(const Expr& f); 00056 00057 /** \relates Expr */ 00058 Expr cross(const Expr& a, const Expr& b); 00059 00060 /** \relates Expr */ 00061 Expr curl(const Expr& f); 00062 00063 /** \relates Expr 00064 * Compute the colon (Frobenius) product of two matrices. The result 00065 * is a scalar. 00066 **/ 00067 Expr colonProduct(const Expr& A, const Expr& B); 00068 00069 /** \relates Expr 00070 * Compute the outer (Kronecker) product of two vectors. The result 00071 * is a dim(a) by dim(b) rectangular matrix. 00072 **/ 00073 Expr outerProduct(const Expr& a, const Expr& b); 00074 00075 /** \relates Expr 00076 * Indicate whether the given expression is a square matrix. If so, 00077 * return by reference argument the size of the matrix. 00078 * 00079 * A scalar is a 1 by 1 matrix. 00080 */ 00081 bool isSquareMatrix(const Expr& x, int& N); 00082 00083 /** \relates Expr 00084 * Indicate whether the given expression is a vector. If so, 00085 * return by reference argument the size of the vector. 00086 * 00087 * A scalar is a vector of dimension 1. 00088 * */ 00089 bool isVector(const Expr& x, int& N); 00090 00091 } 00092 00093 #endif