ParaView
vtkPCosmoReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPCosmoReader.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*=========================================================================
16 
17  Program: VTK/ParaView Los Alamos National Laboratory Modules (PVLANL)
18  Module: vtkPCosmoReader.h
19 
20 Copyright (c) 2009 Los Alamos National Security, LLC
21 
22 All rights reserved.
23 
24 Copyright 2009. Los Alamos National Security, LLC.
25 This software was produced under U.S. Government contract DE-AC52-06NA25396
26 for Los Alamos National Laboratory (LANL), which is operated by
27 Los Alamos National Security, LLC for the U.S. Department of Energy.
28 The U.S. Government has rights to use, reproduce, and distribute this software.
29 NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC MAKES ANY WARRANTY,
30 EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE.
31 If software is modified to produce derivative works, such modified software
32 should be clearly marked, so as not to confuse it with the version available
33 from LANL.
34 
35 Additionally, redistribution and use in source and binary forms, with or
36 without modification, are permitted provided that the following conditions
37 are met:
38 - Redistributions of source code must retain the above copyright notice,
39  this list of conditions and the following disclaimer.
40 - Redistributions in binary form must reproduce the above copyright notice,
41  this list of conditions and the following disclaimer in the documentation
42  and/or other materials provided with the distribution.
43 - Neither the name of Los Alamos National Security, LLC, Los Alamos National
44  Laboratory, LANL, the U.S. Government, nor the names of its contributors
45  may be used to endorse or promote products derived from this software
46  without specific prior written permission.
47 
48 THIS SOFTWARE IS PROVIDED BY LOS ALAMOS NATIONAL SECURITY, LLC AND CONTRIBUTORS
49 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
50 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 ARE DISCLAIMED. IN NO EVENT SHALL LOS ALAMOS NATIONAL SECURITY, LLC OR
52 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
53 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
54 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
55 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
56 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
57 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
58 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
59 
60 =========================================================================*/
86 #ifndef vtkPCosmoReader_h
87 #define vtkPCosmoReader_h
88 
89 #include "vtkPVVTKExtensionsCosmoToolsModule.h" // For export macro
90 #include "vtkUnstructuredGridAlgorithm.h"
91 
92 class vtkMultiProcessController;
93 class vtkStdString;
94 
95 class VTKPVVTKEXTENSIONSCOSMOTOOLS_EXPORT vtkPCosmoReader : public vtkUnstructuredGridAlgorithm
96 {
97 public:
98  static vtkPCosmoReader* New();
99  vtkTypeMacro(vtkPCosmoReader, vtkUnstructuredGridAlgorithm);
100  void PrintSelf(ostream& os, vtkIndent indent);
101 
103 
106  vtkSetStringMacro(FileName);
107  vtkGetStringMacro(FileName);
109 
111 
115  vtkSetMacro(RL, float);
116  vtkGetMacro(RL, float);
118 
120 
125  vtkSetMacro(Overlap, float);
126  vtkGetMacro(Overlap, float);
128 
130 
133  vtkSetMacro(ReadMode, int);
134  vtkGetMacro(ReadMode, int);
136 
149  vtkSetMacro(CosmoFormat, int);
150  vtkGetMacro(CosmoFormat, int);
152 
154 
157  vtkGetObjectMacro(Controller, vtkMultiProcessController);
158  virtual void SetController(vtkMultiProcessController*);
160 
161 protected:
162  vtkPCosmoReader();
163  ~vtkPCosmoReader();
164 
165  virtual int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
166  virtual int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
167 
168  vtkMultiProcessController* Controller;
169 
170  char* FileName; // Name of binary particle file
171  float RL; // The physical box dimensions (rL)
172  float Overlap; // The ghost cell boundary space
173  int ReadMode; // The reading mode
174  // int ByteSwap; // Indicates whether to byte-swap data on read
175  int CosmoFormat; // Enable cosmo format or gadget format
176 
177 private:
178  vtkPCosmoReader(const vtkPCosmoReader&) VTK_DELETE_FUNCTION;
179  void operator=(const vtkPCosmoReader&) VTK_DELETE_FUNCTION;
180 };
181 
182 #endif
Read a binary cosmology data file.
vtkMultiProcessController * Controller