Nektar::FieldUtils::ProcessInterpPointDataToFld Class Reference

This processing module interpolates one field to another. More...

#include <ProcessInterpPointDataToFld.h>

Inheritance diagram for Nektar::FieldUtils::ProcessInterpPointDataToFld:

Public Member Functions
	ProcessInterpPointDataToFld (FieldSharedPtr f)
	~ProcessInterpPointDataToFld () override
Public Member Functions inherited from Nektar::FieldUtils::ProcessModule
	ProcessModule ()
	ProcessModule (FieldSharedPtr p_f)
Public Member Functions inherited from Nektar::FieldUtils::Module
FIELD_UTILS_EXPORT	Module (FieldSharedPtr p_f)
virtual	~Module ()=default
void	Process (po::variables_map &vm)
std::string	GetModuleName ()
std::string	GetModuleDescription ()
const ConfigOption &	GetConfigOption (const std::string &key) const
ModulePriority	GetModulePriority ()
std::vector< ModuleKey >	GetModulePrerequisites ()
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 Attributes
static ModuleKey	className

Protected Member Functions
void	v_Process (po::variables_map &vm) override
	Write mesh to output file. More...
std::string	v_GetModuleName () override
std::string	v_GetModuleDescription () override
ModulePriority	v_GetModulePriority () override
void	PrintProgressbar (const int position, const int goal) const
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
virtual void	v_Process (po::variables_map &vm)
virtual std::string	v_GetModuleName ()
virtual std::string	v_GetModuleDescription ()
virtual ModulePriority	v_GetModulePriority ()
virtual std::vector< ModuleKey >	v_GetModulePrerequisites ()

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. 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

This processing module interpolates one field to another.

Definition at line 49 of file ProcessInterpPointDataToFld.h.

Constructor & Destructor Documentation

ProcessInterpPointDataToFld()

Nektar::FieldUtils::ProcessInterpPointDataToFld::ProcessInterpPointDataToFld

(

FieldSharedPtr

f

)

Definition at line 63 of file ProcessInterpPointDataToFld.cpp.

    : ProcessModule(f)
{
    m_config["frompts"] = ConfigOption(
        false, "NotSet", "Pts file from which to interpolate field");
 
    m_config["interpcoord"] =
        ConfigOption(false, "-1", "coordinate id to use for interpolation");
}

References Nektar::FieldUtils::Module::m_config.

~ProcessInterpPointDataToFld()

Nektar::FieldUtils::ProcessInterpPointDataToFld::~ProcessInterpPointDataToFld ( )

override

Definition at line 73 of file ProcessInterpPointDataToFld.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 53 of file ProcessInterpPointDataToFld.h.

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

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

PrintProgressbar()

void Nektar::FieldUtils::ProcessInterpPointDataToFld::PrintProgressbar ( const int  position, const int  goal  ) const

inlineprotected

Definition at line 81 of file ProcessInterpPointDataToFld.h.

    {
        LibUtilities::PrintProgressbar(position, goal, "Interpolating");
    }

References Nektar::LibUtilities::PrintProgressbar().

Referenced by v_Process().

v_GetModuleDescription()

std::string Nektar::FieldUtils::ProcessInterpPointDataToFld::v_GetModuleDescription ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 71 of file ProcessInterpPointDataToFld.h.

    {
        return "Interpolating data to field";
    }

v_GetModuleName()

std::string Nektar::FieldUtils::ProcessInterpPointDataToFld::v_GetModuleName ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 66 of file ProcessInterpPointDataToFld.h.

    {
        return "ProcessInterpPointDataToFld";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessInterpPointDataToFld::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 76 of file ProcessInterpPointDataToFld.h.

    {
        return eFillExp;
    }

References Nektar::FieldUtils::eFillExp.

v_Process()

void Nektar::FieldUtils::ProcessInterpPointDataToFld::v_Process ( po::variables_map &  vm )

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 77 of file ProcessInterpPointDataToFld.cpp.

{
    m_f->SetUpExp(vm);
 
    int i, j;
    LibUtilities::PtsFieldSharedPtr fieldPts;
    // Load pts file
    ASSERTL0(m_config["frompts"].as<string>().compare("NotSet") != 0,
             "ProcessInterpPointDataToFld requires frompts parameter");
    string inFile = m_config["frompts"].as<string>().c_str();
 
    int totpoints = m_f->m_exp[0]->GetTotPoints();
 
    Array<OneD, Array<OneD, NekDouble>> intFields(3);
    for (int i = 0; i < 3; ++i)
    {
        intFields[i] = Array<OneD, NekDouble>(totpoints, 0.);
    }
    m_f->m_exp[0]->GetCoords(intFields[0], intFields[1], intFields[2]);
 
    if (fs::path(inFile).extension() == ".pts")
    {
        LibUtilities::PtsIOSharedPtr ptsIO =
            MemoryManager<LibUtilities::PtsIO>::AllocateSharedPtr(m_f->m_comm);
 
        ptsIO->Import(inFile, fieldPts);
    }
    else if (fs::path(inFile).extension() == ".csv")
    {
        LibUtilities::CsvIOSharedPtr csvIO =
            MemoryManager<LibUtilities::CsvIO>::AllocateSharedPtr(m_f->m_comm);
 
        LibUtilities::DomainRangeShPtr Range =
            MemoryManager<LibUtilities::DomainRange>::AllocateSharedPtr();
 
        NekDouble vmax, vmin, margin = 0.1;
        vmax          = intFields[0][Vmath::Imax(totpoints, intFields[0], 1)];
        vmin          = intFields[0][Vmath::Imin(totpoints, intFields[0], 1)];
        Range->m_xmax = (vmax - vmin) * margin + vmax;
        Range->m_xmin = -(vmax - vmin) * margin + vmin;
 
        vmax          = intFields[1][Vmath::Imax(totpoints, intFields[1], 1)];
        vmin          = intFields[1][Vmath::Imin(totpoints, intFields[1], 1)];
        Range->m_ymax = (vmax - vmin) * margin + vmax;
        Range->m_ymin = -(vmax - vmin) * margin + vmin;
 
        vmax          = intFields[2][Vmath::Imax(totpoints, intFields[2], 1)];
        vmin          = intFields[2][Vmath::Imin(totpoints, intFields[2], 1)];
        Range->m_zmax = (vmax - vmin) * margin + vmax;
        Range->m_zmin = -(vmax - vmin) * margin + vmin;
 
        csvIO->Import(inFile, fieldPts, LibUtilities::NullFieldMetaDataMap,
                      Range);
    }
    else
    {
        ASSERTL0(false, "unknown frompts file type");
    }
 
    int nFields = fieldPts->GetNFields();
    ASSERTL0(nFields > 0, "No field values provided in input");
 
    // Define new expansions.
    ASSERTL0(
        m_f->m_numHomogeneousDir == 0,
        "ProcessInterpPointDataToFld does not support homogeneous expansion");
 
    m_f->m_exp.resize(nFields);
    for (i = 1; i < nFields; ++i)
    {
        m_f->m_exp[i] = m_f->AppendExpList(m_f->m_numHomogeneousDir);
    }
 
    Array<OneD, Array<OneD, NekDouble>> intFields1(3 + nFields);
 
    for (int i = 0; i < 3; ++i)
    {
        intFields1[i] = intFields[i];
    }
 
    // Declare space for interpolated fields
    for (int i = 3; i < 3 + nFields; ++i)
    {
        intFields1[i] = Array<OneD, NekDouble>(totpoints);
    }
 
    LibUtilities::PtsFieldSharedPtr outPts =
        MemoryManager<LibUtilities::PtsField>::AllocateSharedPtr(3, intFields1);
 
    int coord_id = m_config["interpcoord"].as<int>();
    ASSERTL0(coord_id <= static_cast<int>(outPts->GetDim()) - 1,
             "interpcoord is bigger than the Pts files dimension");
 
    Interpolator<std::vector<MultiRegions::ExpListSharedPtr>> interp(
        LibUtilities::eNoMethod, coord_id);
 
    if (m_f->m_verbose && m_f->m_comm->TreatAsRankZero())
    {
        interp.SetProgressCallback(
            &ProcessInterpPointDataToFld::PrintProgressbar, this);
    }
    interp.Interpolate(fieldPts, outPts);
    if (m_f->m_verbose && m_f->m_comm->TreatAsRankZero())
    {
        cout << endl;
    }
 
    for (i = 0; i < totpoints; ++i)
    {
        for (j = 0; j < nFields; ++j)
        {
            m_f->m_exp[j]->SetPhys(i, outPts->GetPointVal(3 + j, i));
        }
    }
    // forward transform fields
    for (i = 0; i < nFields; ++i)
    {
        m_f->m_exp[i]->FwdTransLocalElmt(m_f->m_exp[i]->GetPhys(),
                                         m_f->m_exp[i]->UpdateCoeffs());
    }
 
    // save field names
    for (int j = 0; j < fieldPts->GetNFields(); ++j)
    {
        m_f->m_variables.push_back(fieldPts->GetFieldName(j));
    }
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::LibUtilities::eNoMethod, Vmath::Imax(), Vmath::Imin(), Nektar::FieldUtils::Interpolator< T >::Interpolate(), Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, Nektar::LibUtilities::NullFieldMetaDataMap, PrintProgressbar(), and Nektar::LibUtilities::Interpolator::SetProgressCallback().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessInterpPointDataToFld::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "interppointdatatofld"),
        ProcessInterpPointDataToFld::create,
        "Interpolates given discrete data using a finite difference "
        "approximation to a fld file given a xml file")

Definition at line 57 of file ProcessInterpPointDataToFld.h.