WMWriteField.cpp

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2017 OpenWalnut Community
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#include <string>
 
#include "core/kernel/WKernel.h"
 
#include "WMWriteField.h"
#include "core/dataHandler/WDataSetScalar.h"
#include "core/dataHandler/WGridRegular3D.h"
#include "core/common/WPathHelper.h"
 
// This line is needed by the module loader to actually find your module. Do not remove. Do NOT add a ";" here.
W_LOADABLE_MODULE( WMWriteField )
 
WMWriteField::WMWriteField():
    WModule()
{
}
 
WMWriteField::~WMWriteField()
{
    // Cleanup!
}
 
boost::shared_ptr< WModule > WMWriteField::factory() const
{
    // See "src/modules/template/" for an extensively documented example.
    return boost::shared_ptr< WModule >( new WMWriteField() );
}
 
const std::string WMWriteField::getName() const
{
    // Specify your module name here. This name must be UNIQUE!
    return "Write Field";
}
 
const std::string WMWriteField::getDescription() const
{
    // Specify your module description here. Be detailed. This text is read by the user.
    // See "src/modules/template/" for an extensively documented example.
    return "This module writes a scalar field to a file. Different file formats are supported.";
}
 
void WMWriteField::connectors()
{
    m_field = boost::shared_ptr<WModuleInputData<WDataSetScalar> >(
            new WModuleInputData<WDataSetScalar> ( shared_from_this(), "Scalar Field",
                    "The field to be saved." ) );
    addConnector( m_field );
 
    WModule::connectors();
}
 
void WMWriteField::properties()
{
    m_propCondition = boost::shared_ptr< WCondition >( new WCondition() );
    m_saveTriggerProp = m_properties->addProperty( "Do save",  "Press!", WPVBaseTypes::PV_TRIGGER_READY, m_propCondition );
    m_outputFile = m_properties->addProperty( "File", "", WPathHelper::getAppPath() );
 
    WModule::properties();
}
 
void WMWriteField::requirements()
{
}
 
void WMWriteField::moduleMain()
{
    m_moduleState.add( m_field->getDataChangedCondition() );
    m_moduleState.add( m_propCondition );
 
    // signal ready state
    ready();
 
    // loop until the module container requests the module to quit
    while( !m_shutdownFlag() )
    {  // Now, the moduleState variable comes into play. The module can wait for the condition, which gets fired whenever the input receives data
        // or an property changes. The main loop now waits until something happens.
        debugLog() << "Waiting ...";
        m_moduleState.wait();
        m_saveTriggerProp->set( WPVBaseTypes::PV_TRIGGER_READY, false );
 
        // woke up since the module is requested to finish
        if( m_shutdownFlag() )
        {
            break;
        }
 
        saveVTKASCII();
        m_saveTriggerProp->set( WPVBaseTypes::PV_TRIGGER_READY, true );
    }
 
}
 
bool WMWriteField::saveVTKASCII() const
{
    const char* c_file = m_outputFile->get().string().c_str();
    std::ofstream dataFile( c_file, std::ios_base::binary );
 
    if( dataFile )
    {
        WLogger::getLogger()->addLogMessage( "opening file", "Write Field", LL_DEBUG );
    }
    else
    {
        WLogger::getLogger()->addLogMessage( "open file failed" + m_outputFile->get().string() , "Write Field", LL_ERROR );
        return false;
    }
 
    dataFile.precision( 16 );
 
    WLogger::getLogger()->addLogMessage( "start writing file", "Write Field", LL_DEBUG );
    dataFile << ( "# vtk DataFile Version 2.0\n" );
    dataFile << ( "Generated using OpenWalnut\n" );
    dataFile << ( "ASCII\n" );
    dataFile << ( "DATASET STRUCTURED_POINTS\n" );
 
 
    boost::shared_ptr< WDataSetScalar > m_dataSet = m_field->getData();
    boost::shared_ptr<WGridRegular3D> grid = boost::dynamic_pointer_cast< WGridRegular3D >( m_dataSet->getGrid() );
    WAssert( grid, "Grid is not of type WGridRegular3D." );
 
    size_t x_dim = grid->getNbCoordsX();
    size_t y_dim = grid->getNbCoordsY();
    size_t z_dim = grid->getNbCoordsZ();
    dataFile << "DIMENSIONS " << x_dim << " "
                              << y_dim << " "
                              << z_dim << "\n";
 
    size_t x_origin = grid->getOrigin()[0];
    size_t y_origin = grid->getOrigin()[1];
    size_t z_origin = grid->getOrigin()[2];
    dataFile << "ORIGIN " << x_origin << " "
                                << y_origin << " "
                                << z_origin << "\n";
 
    size_t x_asp = grid->getOffsetX();
    size_t y_asp = grid->getOffsetY();
    size_t z_asp = grid->getOffsetZ();
    dataFile << "SPACING " << x_asp << " "
                                << y_asp << " "
                                << z_asp << "\n";
 
    size_t nbPoints = x_dim * y_dim * z_dim;
    dataFile << "POINT_DATA " << nbPoints << "\n";
    dataFile << "SCALARS fieldValues float\n";
    dataFile << "LOOKUP_TABLE default\n";
 
 
    boost::shared_ptr< WValueSetBase > valueSet( m_dataSet->getValueSet() );
    for( size_t id = 0; id < nbPoints; ++id )
    {
        dataFile << valueSet->getScalarDouble( id ) << " ";
    }
 
    dataFile << "\n";
 
    dataFile.close();
    WLogger::getLogger()->addLogMessage( "Saving done.", "Write Field", LL_DEBUG );
    return true;
}