Tecplot output class, specifically for binary field output. More...

#include <OutputTecplot.h>

Inheritance diagram for Nektar::FieldUtils::OutputTecplotBinary:

Public Member Functions
	OutputTecplotBinary (FieldSharedPtr f)

virtual	~OutputTecplotBinary ()

Public Member Functions inherited from Nektar::FieldUtils::OutputTecplot
	OutputTecplot (FieldSharedPtr f)

virtual	~OutputTecplot ()

virtual void	Process (po::variables_map &vm)
	Write fld to output file. More...

virtual std::string	GetModuleName ()

Public Member Functions inherited from Nektar::FieldUtils::OutputFileBase
	OutputFileBase (FieldSharedPtr f)

virtual	~OutputFileBase ()

virtual std::string	GetModuleDescription ()

virtual ModulePriority	GetModulePriority ()

Public Member Functions inherited from Nektar::FieldUtils::OutputModule
	OutputModule (FieldSharedPtr p_f)

FIELD_UTILS_EXPORT void	OpenStream ()
	Open a file for output. More...

Public Member Functions inherited from Nektar::FieldUtils::Module
FIELD_UTILS_EXPORT	Module (FieldSharedPtr p_f)

virtual	~Module ()=default

const ConfigOption &	GetConfigOption (const std::string &key) const

FIELD_UTILS_EXPORT void	RegisterConfig (std::string key, std::string value="")
	Register a configuration option with a module. More...

FIELD_UTILS_EXPORT void	PrintConfig ()
	Print out all configuration options for a module. More...

FIELD_UTILS_EXPORT void	SetDefaults ()
	Sets default configuration options for those which have not been set. More...

FIELD_UTILS_EXPORT void	AddFile (std::string fileType, std::string fileName)

FIELD_UTILS_EXPORT void	EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)

Static Public Member Functions
static std::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Member Functions inherited from Nektar::FieldUtils::OutputTecplot
static std::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	m_className

Static Public Attributes inherited from Nektar::FieldUtils::OutputTecplot
static ModuleKey	m_className

Protected Member Functions
void	WriteDoubleOrFloat (std::ofstream &outfile, Array< OneD, NekDouble > &data)
	Write either double-precision or single-precision output of field data. More...

virtual void	WriteTecplotHeader (std::ofstream &outfile, std::vector< std::string > &var)
	Write Tecplot files header in binary format. More...

virtual void	WriteTecplotZone (std::ofstream &outfile)

virtual void	WriteTecplotConnectivity (std::ofstream &outfile)
	Write Tecplot connectivity information (ASCII) More...

Protected Member Functions inherited from Nektar::FieldUtils::OutputTecplot
virtual void	OutputFromPts (po::variables_map &vm)
	Write from pts to output file. More...

virtual void	OutputFromExp (po::variables_map &vm)
	Write from m_exp to output file. More...

virtual void	OutputFromData (po::variables_map &vm)
	Write from data to output file. More...

virtual fs::path	GetPath (std::string &filename, po::variables_map &vm)

virtual fs::path	GetFullOutName (std::string &filename, po::variables_map &vm)

void	WriteTecplotFile (po::variables_map &vm)

int	GetNumTecplotBlocks ()
	Calculate number of Tecplot blocks. More...

void	CalculateConnectivity ()
	Calculate connectivity information for each expansion dimension. More...

Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...

Protected Attributes inherited from Nektar::FieldUtils::OutputTecplot
bool	m_binary
	True if writing binary field output. More...

bool	m_oneOutputFile
	True if writing a single output file. More...

bool	m_writeHeader
	True if writing header. More...

TecplotZoneType	m_zoneType
	Tecplot zone type of output. More...

std::vector< int >	m_numPoints
	Number of points per block in Tecplot file. More...

int	m_numBlocks
	Number of blocks in Tecplot file. More...

int	m_coordim
	Coordinate dimension of output. More...

int	m_totConn
	Total number of connectivity entries. More...

std::vector< Array< OneD, int > >	m_conn
	Connectivty for each block: one per element. More...

Array< OneD, int >	m_rankFieldSizes
	Each rank's field sizes. More...

Array< OneD, int >	m_rankConnSizes
	Each rank's connectivity sizes. More...

Array< OneD, Array< OneD, NekDouble > >	m_fields
	Field data to output. More...

Protected Attributes inherited from Nektar::FieldUtils::OutputFileBase
bool	m_requireEquiSpaced

Protected Attributes inherited from Nektar::FieldUtils::OutputModule
std::ofstream	m_fldFile
	Output stream. More...

Protected Attributes inherited from Nektar::FieldUtils::Module
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...

std::set< std::string >	m_allowedFiles
	List of allowed file formats. More...

Detailed Description

Tecplot output class, specifically for binary field output.

Definition at line 137 of file OutputTecplot.h.

Constructor & Destructor Documentation

◆ OutputTecplotBinary()

Nektar::FieldUtils::OutputTecplotBinary::OutputTecplotBinary ( FieldSharedPtr f )

inline

Definition at line 147 of file OutputTecplot.h.

                                           : OutputTecplot(f)
     {
         m_binary = true;
     }

References Nektar::FieldUtils::OutputTecplot::m_binary.

◆ ~OutputTecplotBinary()

virtual Nektar::FieldUtils::OutputTecplotBinary::~OutputTecplotBinary ( )

inlinevirtual

Definition at line 152 of file OutputTecplot.h.

153 {

154 }

Member Function Documentation

◆ create()

static std::shared_ptr<Module> Nektar::FieldUtils::OutputTecplotBinary::create ( FieldSharedPtr f )

inlinestatic

Creates an instance of this class.

Definition at line 141 of file OutputTecplot.h.

     {
         return MemoryManager<OutputTecplotBinary>::AllocateSharedPtr(f);
     }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

◆ WriteDoubleOrFloat()

void Nektar::FieldUtils::OutputTecplotBinary::WriteDoubleOrFloat	(	std::ofstream &	outfile,
		Array< OneD, NekDouble > &	data
	)

protected

Write either double-precision or single-precision output of field data.

Parameters

outfile	Output file name.
expansion	Expansion that is considered

Definition at line 675 of file OutputTecplot.cpp.

 {
     // Data format: either double or single depending on user options
     bool useDoubles = m_config["double"].as<bool>();
  
     if (useDoubles)
     {
         // For doubles, we can just write data.
         WriteStream(outfile, data);
     }
     else
     {
         // For single precision, needs typecast first.
         int nPts = data.size();
         std::vector<float> tmp(data.size());
         std::copy(&data[0], &data[0] + nPts, &tmp[0]);
         WriteStream(outfile, tmp);
     }
 }

References CellMLToNektar.pycml::copy(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::WriteStream().

Referenced by WriteTecplotZone().

◆ WriteTecplotConnectivity()

void Nektar::FieldUtils::OutputTecplotBinary::WriteTecplotConnectivity ( std::ofstream & outfile )

protectedvirtual

Write Tecplot connectivity information (ASCII)

Parameters

outfile Output file

Reimplemented from Nektar::FieldUtils::OutputTecplot.

Definition at line 903 of file OutputTecplot.cpp.

 {
     if (m_oneOutputFile && m_f->m_comm->GetRank() > 0)
     {
         // Need to amalgamate connectivity information
         Array<OneD, int> conn(m_totConn);
         for (int i = 0, cnt = 0; i < m_conn.size(); ++i)
         {
             Vmath::Vcopy(m_conn[i].size(), &m_conn[i][0], 1,
                          &conn[cnt], 1);
             cnt += m_conn[i].size();
         }
         m_f->m_comm->Send(0, conn);
     }
     else
     {
         for (int i = 0; i < m_conn.size(); ++i)
         {
             WriteStream(outfile, m_conn[i]);
         }
  
         if (m_oneOutputFile && m_f->m_comm->GetRank() == 0)
         {
             int offset = m_rankFieldSizes[0];
  
             for (int n = 1; n < m_f->m_comm->GetSize(); ++n)
             {
                 Array<OneD, int> conn(m_rankConnSizes[n]);
                 m_f->m_comm->Recv(n, conn);
  
                 for (int j = 0; j < conn.size(); ++j)
                 {
                     conn[j] += offset;
                 }
  
                 WriteStream(outfile, conn);
                 offset += m_rankFieldSizes[n];
             }
         }
     }
 }

References Nektar::FieldUtils::OutputTecplot::m_conn, Nektar::FieldUtils::Module::m_f, Nektar::FieldUtils::OutputTecplot::m_oneOutputFile, Nektar::FieldUtils::OutputTecplot::m_rankConnSizes, Nektar::FieldUtils::OutputTecplot::m_rankFieldSizes, Nektar::FieldUtils::OutputTecplot::m_totConn, Vmath::Vcopy(), and Nektar::FieldUtils::WriteStream().

◆ WriteTecplotHeader()

void Nektar::FieldUtils::OutputTecplotBinary::WriteTecplotHeader	(	std::ofstream &	outfile,
		std::vector< std::string > &	var
	)

protectedvirtual

Write Tecplot files header in binary format.

Parameters

outfile	Output file name
var	Variables names

Reimplemented from Nektar::FieldUtils::OutputTecplot.

Definition at line 477 of file OutputTecplot.cpp.

 {
     if (m_oneOutputFile && m_f->m_comm->GetRank() > 0)
     {
         return;
     }
  
     // Version number
     outfile << "#!TDV112";
  
     // Int value of 1 for endian check
     WriteStream(outfile, 1);
  
     // We'll probably write a full solution field
     WriteStream(outfile, 0);
  
     // Title
     std::string title = "";
     WriteStream(outfile, title);
  
     // Number of variables
     WriteStream(outfile, (int)var.size());
  
     for (int i = 0; i < var.size(); ++i)
     {
         WriteStream(outfile, var[i]);
     }
 }

References Nektar::FieldUtils::Module::m_f, Nektar::FieldUtils::OutputTecplot::m_oneOutputFile, CG_Iterations::title, and Nektar::FieldUtils::WriteStream().

◆ WriteTecplotZone()

void Nektar::FieldUtils::OutputTecplotBinary::WriteTecplotZone ( std::ofstream & outfile )

protectedvirtual

Write Tecplot zone output in binary

Parameters

outfile	Output file name.
expansion	Expansion that is considered

Reimplemented from Nektar::FieldUtils::OutputTecplot.

Definition at line 702 of file OutputTecplot.cpp.

 {
     Array<OneD, NekDouble> fieldMin(m_fields.size());
     Array<OneD, NekDouble> fieldMax(m_fields.size());
  
     // Data format: either double or single depending on user options
     bool useDoubles = m_config["double"].as<bool>();
  
     if ((m_oneOutputFile && m_f->m_comm->GetRank() == 0) || !m_oneOutputFile)
     {
         // Don't bother naming zone
         WriteStream(outfile, 299.0f); // Zone marker
  
         // Write same name as preplot
         int rank   = m_f->m_comm->GetRank();
         string zonename = "ZONE " + boost::lexical_cast<string>(rank);
         WriteStream(outfile, zonename);
  
         WriteStream(outfile, -1); // No parent zone
         WriteStream(outfile, -1); // No strand ID
         WriteStream(outfile, 0.0); // Solution time
         WriteStream(outfile, -1); // Unused, set to -1
  
         // Zone type: 1 = lineseg, 3 = quad, 5 = brick
         WriteStream(outfile, (int)m_zoneType);
  
         WriteStream(outfile, 0); // Data at nodes
         WriteStream(outfile, 0); // No 1-1 face neighbours
         WriteStream(outfile, 0); // No user-defined connections
  
         if (m_zoneType == eOrdered)
         {
             for (int i = 0; i < m_numPoints.size(); ++i)
             {
                 WriteStream(outfile, m_numPoints[i]);
             }
  
             for (int i = m_numPoints.size(); i < 3; ++i)
             {
                 WriteStream(outfile, 0);
             }
         }
         else
         {
             // Number of points in zone
             int nPoints = m_oneOutputFile ?
                 Vmath::Vsum(m_f->m_comm->GetSize(), m_rankFieldSizes, 1) :
                 m_fields[0].size();
  
             WriteStream(outfile, nPoints); // Total number of points
             WriteStream(outfile, m_numBlocks); // Number of blocks
             WriteStream(outfile, 0); // Unused
             WriteStream(outfile, 0); // Unused
             WriteStream(outfile, 0); // Unused
         }
  
         WriteStream(outfile, 0); // No auxiliary data names
  
         // Finalise header
         WriteStream(outfile, 357.0f);
  
         // Now start to write data section so that we can dump geometry
         // information
  
         // Data marker
         WriteStream(outfile, 299.0f);
  
         for (int j = 0; j < m_fields.size(); ++j)
         {
             WriteStream(outfile, useDoubles ? 2 : 1);
         }
  
         // No passive variables or variable sharing, no zone connectivity
         // sharing (we only dump one zone)
         WriteStream(outfile, 0);
         WriteStream(outfile, 0);
         WriteStream(outfile, -1);
     }
  
     for (int i = 0; i < m_fields.size(); ++i)
     {
         fieldMin[i] = Vmath::Vmin(m_fields[i].size(), m_fields[i], 1);
         fieldMax[i] = Vmath::Vmax(m_fields[i].size(), m_fields[i], 1);
     }
  
     m_f->m_comm->AllReduce(fieldMin, LibUtilities::ReduceMin);
     m_f->m_comm->AllReduce(fieldMax, LibUtilities::ReduceMax);
  
     // Write out min/max of field data
     if ((m_oneOutputFile && m_f->m_comm->GetRank() == 0) || !m_oneOutputFile)
     {
         for (int i = 0; i < m_fields.size(); ++i)
         {
             WriteStream(outfile, fieldMin[i]);
             WriteStream(outfile, fieldMax[i]);
         }
     }
  
     if (m_oneOutputFile && m_f->m_comm->GetRank() == 0)
     {
         for (int i = 0; i < m_fields.size(); ++i)
         {
             WriteDoubleOrFloat(outfile, m_fields[i]);
  
             for (int n = 1; n < m_f->m_comm->GetSize(); ++n)
             {
                 Array<OneD, NekDouble> tmp(m_rankFieldSizes[n]);
                 m_f->m_comm->Recv(n, tmp);
                 WriteDoubleOrFloat(outfile, tmp);
             }
         }
     }
     else if (m_oneOutputFile && m_f->m_comm->GetRank() > 0)
     {
         for (int i = 0; i < m_fields.size(); ++i)
         {
             m_f->m_comm->Send(0, m_fields[i]);
         }
     }
     else
     {
         for (int i = 0; i < m_fields.size(); ++i)
         {
             WriteDoubleOrFloat(outfile, m_fields[i]);
         }
     }
 }

Member Data Documentation

◆ m_className

ModuleKey Nektar::FieldUtils::OutputTecplotBinary::m_className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eOutputModule, "plt"),
        OutputTecplotBinary::create,
        "Writes a Tecplot file in binary plt format.")

Definition at line 146 of file OutputTecplot.h.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutputTecplotBinary()

◆ ~OutputTecplotBinary()

Member Function Documentation

◆ create()

◆ WriteDoubleOrFloat()

◆ WriteTecplotConnectivity()

◆ WriteTecplotHeader()

◆ WriteTecplotZone()

Member Data Documentation

◆ m_className