00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Sundance 00005 // Copyright (2005) Sandia Corporation 00006 // 00007 // Copyright (year first published) Sandia Corporation. Under the terms 00008 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 00009 // retains certain rights in this software. 00010 // 00011 // This library is free software; you can redistribute it and/or modify 00012 // it under the terms of the GNU Lesser General Public License as 00013 // published by the Free Software Foundation; either version 2.1 of the 00014 // License, or (at your option) any later version. 00015 // 00016 // This library is distributed in the hope that it will be useful, but 00017 // WITHOUT ANY WARRANTY; without even the implied warranty of 00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00019 // Lesser General Public License for more details. 00020 // 00021 // You should have received a copy of the GNU Lesser General Public 00022 // License along with this library; if not, write to the Free Software 00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 00024 // USA 00025 // Questions? Contact Kevin Long (krlong@sandia.gov), 00026 // Sandia National Laboratories, Livermore, California, USA 00027 // 00028 // ************************************************************************ 00029 /* @HEADER@ */ 00030 00031 #ifndef SUNDANCE_VECTORCALCULUS_H 00032 #define SUNDANCE_VECTORCALCULUS_H 00033 00034 #include "SundanceExpr.hpp" 00035 00036 namespace Sundance 00037 { 00038 00039 00040 /** \relates Expr */ 00041 Expr gradient(int dim); 00042 00043 /** \relates Expr */ 00044 Expr div(const Expr& f); 00045 00046 /** \relates Expr */ 00047 Expr cross(const Expr& a, const Expr& b); 00048 00049 /** \relates Expr */ 00050 Expr curl(const Expr& f); 00051 00052 /** \relates Expr 00053 * Compute the colon (Frobenius) product of two matrices. The result 00054 * is a scalar. 00055 **/ 00056 Expr colonProduct(const Expr& A, const Expr& B); 00057 00058 /** \relates Expr 00059 * Compute the outer (Kronecker) product of two vectors. The result 00060 * is a dim(a) by dim(b) rectangular matrix. 00061 **/ 00062 Expr outerProduct(const Expr& a, const Expr& b); 00063 00064 /** \relates Expr 00065 * Indicate whether the given expression is a square matrix. If so, 00066 * return by reference argument the size of the matrix. 00067 * 00068 * A scalar is a 1 by 1 matrix. 00069 */ 00070 bool isSquareMatrix(const Expr& x, int& N); 00071 00072 /** \relates Expr 00073 * Indicate whether the given expression is a vector. If so, 00074 * return by reference argument the size of the vector. 00075 * 00076 * A scalar is a vector of dimension 1. 00077 * */ 00078 bool isVector(const Expr& x, int& N); 00079 00080 } 00081 00082 #endif