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_FIELDWRITER_H 00032 #define SUNDANCE_FIELDWRITER_H 00033 00034 #include "SundanceDefs.hpp" 00035 #include "SundanceFieldWriterBase.hpp" 00036 #include "PlayaHandle.hpp" 00037 00038 namespace Sundance 00039 { 00040 /** 00041 * FieldWriter is the user level object for writing fields and meshes 00042 * to output stream. 00043 * 00044 * <h4> Example: </h4> Write fields u0 and w0 to a VTK file "results.vtu" 00045 * \code 00046 * FieldWriter vtkWriter = new VTKWriter("results"); 00047 * vtkWriter.addField(u0); 00048 * vtkWriter.addField(w0); 00049 * vtkWriter.write(); 00050 * \endcode 00051 * 00052 * <h4> Example: </h4> Write verbose mesh information to cout 00053 * \code 00054 * FieldWriter writer = new VerboseFieldWriter(); 00055 * writer.addMesh(mesh); 00056 * writer.write(); 00057 * \endcode 00058 */ 00059 class FieldWriter : public Playa::Handle<FieldWriterBase> 00060 { 00061 public: 00062 /* Boilerplate handle ctors */ 00063 HANDLE_CTORS(FieldWriter, FieldWriterBase); 00064 00065 /** add a mesh to the list of things to be written */ 00066 void addMesh(const Mesh& mesh) const ; 00067 00068 /** add a field, tagging it with the given std::string as a name */ 00069 void addField(const std::string& name, 00070 const Playa::Handle<FieldBase>& field) ; 00071 00072 /** set the numerical value to be written at cells on which 00073 * a field is undefined. Default value is 0.0. */ 00074 void setUndefinedValue(const double& x); 00075 00076 /** 00077 * Tell the writer to pretend that it is running as one of nProc processes 00078 * with the given rank. This is used when partitioning meshes in serial. 00079 */ 00080 void impersonateParallelProc(int nProc, int rank) 00081 { 00082 ptr()->impersonateParallelProc(nProc, rank); 00083 } 00084 00085 00086 00087 /** write to stream */ 00088 void write() const ; 00089 }; 00090 } 00091 00092 #endif