Nektar::FieldUtils::ProcessPointDataToFld Class Reference

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

#include <ProcessPointDataToFld.h>

Inheritance diagram for Nektar::FieldUtils::ProcessPointDataToFld:

Public Member Functions
	ProcessPointDataToFld (FieldSharedPtr f)
	~ProcessPointDataToFld () 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
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 48 of file ProcessPointDataToFld.h.

Constructor & Destructor Documentation

ProcessPointDataToFld()

Nektar::FieldUtils::ProcessPointDataToFld::ProcessPointDataToFld

(

FieldSharedPtr

f

)

Definition at line 54 of file ProcessPointDataToFld.cpp.

    : ProcessModule(f)
{
    m_config["setnantovalue"] = ConfigOption(
        false, "NotSet", "reset any nan value to prescribed value");
 
    m_config["frompts"] = ConfigOption(
        false, "NotSet", "Pts file from which to interpolate field");
}

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

~ProcessPointDataToFld()

Nektar::FieldUtils::ProcessPointDataToFld::~ProcessPointDataToFld ( )

override

Definition at line 64 of file ProcessPointDataToFld.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 52 of file ProcessPointDataToFld.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 70 of file ProcessPointDataToFld.h.

    {
        return "Projecting data to expansion";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 65 of file ProcessPointDataToFld.h.

    {
        return "ProcessPointDataToFld";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessPointDataToFld::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 75 of file ProcessPointDataToFld.h.

    {
        return eFillExp;
    }

References Nektar::FieldUtils::eFillExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file ProcessPointDataToFld.cpp.

{
    m_f->SetUpExp(vm);
 
    int i, j;
    bool setnantovalue = false;
    NekDouble defvalue = 0.0;
 
    if (!boost::iequals(m_config["setnantovalue"].as<string>(), "NotSet"))
    {
        setnantovalue = true;
        defvalue      = m_config["setnantovalue"].as<NekDouble>();
    }
 
    // Check for command line point specification if no .pts file specified
    // Load pts file
    LibUtilities::PtsFieldSharedPtr fieldPts;
    ASSERTL0(m_config["frompts"].as<string>().compare("NotSet") != 0,
             "ProcessInterpPointDataToFld requires frompts parameter");
    string inFile = m_config["frompts"].as<string>().c_str();
    LibUtilities::CommSharedPtr c =
        LibUtilities::GetCommFactory().CreateInstance("Serial", 0, 0);
 
    // Determine file format from file extension
    if (fs::path(inFile).extension() == ".pts")
    {
        LibUtilities::PtsIO(c).Import(inFile, fieldPts);
    }
    else if (fs::path(inFile).extension() == ".csv")
    {
        LibUtilities::CsvIO(c).Import(inFile, fieldPts);
    }
    else
    {
        NEKERROR(ErrorUtil::efatal,
                 "Unsupported file format for the \"frompts\" parameter. "
                 "Supported formats: \".pts\" and \".csv\"");
    }
 
    int nFields = fieldPts->GetNFields();
    ASSERTL0(nFields > 0, "No field values provided in input");
 
    int dim = fieldPts->GetDim();
 
    // assume one field is already defined from input file.
    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>> pts;
    fieldPts->GetPts(pts);
 
    // set any nan values to default value if requested
    if (setnantovalue)
    {
        for (int i = 0; i < pts[0].size(); ++i)
        {
            for (int j = 0; j < nFields; ++j)
            {
                if ((boost::math::isnan)(pts[j + dim][i]))
                {
                    pts[j + dim][i] = defvalue;
                }
            }
        }
    }
 
    if (fieldPts->m_ptsInfo.count(LibUtilities::eIsEquiSpacedData) != 0)
    {
        int totcoeffs = m_f->m_exp[0]->GetNcoeffs();
 
        ASSERTL0(pts[0].size() != totcoeffs,
                 "length of points in .pts file is different "
                 "to the number of coefficients in expansion ");
 
        for (int i = 0; i < nFields; ++i)
        {
            Array<OneD, NekDouble> coeffs = m_f->m_exp[i]->UpdateCoeffs(), tmp;
            int cnt                       = 0;
            for (int e = 0; e < m_f->m_exp[0]->GetNumElmts(); ++e)
            {
                int ncoeffs = m_f->m_exp[i]->GetExp(e)->GetNcoeffs();
                int offset  = m_f->m_exp[i]->GetCoeff_Offset(e);
                Vmath::Vcopy(ncoeffs, &pts[i + dim][cnt], 1, &coeffs[offset],
                             1);
 
                m_f->m_exp[i]->GetExp(e)->EquiSpacedToCoeffs(
                    coeffs + offset, tmp = coeffs + offset);
                cnt += ncoeffs;
            }
            m_f->m_exp[i]->BwdTrans(m_f->m_exp[i]->GetCoeffs(),
                                    m_f->m_exp[i]->UpdatePhys());
        }
    }
    else
    {
        int totpoints = m_f->m_exp[0]->GetTotPoints();
        Array<OneD, Array<OneD, NekDouble>> coords(3);
 
        coords[0] = Array<OneD, NekDouble>(totpoints);
        coords[1] = Array<OneD, NekDouble>(totpoints);
        coords[2] = Array<OneD, NekDouble>(totpoints);
 
        m_f->m_exp[0]->GetCoords(coords[0], coords[1], coords[2]);
 
        if (pts[0].size() != totpoints)
        {
            WARNINGL0(false, "length of points in .pts file is different to "
                             "the number of quadrature points in xml file");
            totpoints = min(totpoints, (int)pts[0].size());
        }
 
        for (j = 0; j < dim; ++j)
        {
            for (i = 0; i < totpoints; ++i)
            {
                if (fabs(coords[j][i] - pts[j][i]) > 1e-4)
                {
                    string outstring =
                        "Coordinates do not match within 1e-4: " +
                        boost::lexical_cast<string>(coords[j][i]) + " versus " +
                        boost::lexical_cast<string>(pts[j][i]) + " diff " +
                        boost::lexical_cast<string>(
                            fabs(coords[j][i] - pts[j][i]));
                    ;
                    WARNINGL0(false, outstring);
                }
            }
        }
 
        for (j = 0; j < nFields; ++j)
        {
            Array<OneD, NekDouble> phys = m_f->m_exp[j]->UpdatePhys();
 
            for (i = 0; i < totpoints; ++i)
            {
                phys[i] = pts[j + dim][i];
            }
 
            // forward transform fields
            m_f->m_exp[j]->FwdTransLocalElmt(phys,
                                             m_f->m_exp[j]->UpdateCoeffs());
        }
    }
 
    // save field names
    for (int j = 0; j < fieldPts->GetNFields(); ++j)
    {
        m_f->m_variables.push_back(fieldPts->GetFieldName(j));
    }
}

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::ErrorUtil::efatal, Nektar::LibUtilities::eIsEquiSpacedData, Nektar::LibUtilities::GetCommFactory(), Nektar::LibUtilities::PtsIO::Import(), Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, NEKERROR, Vmath::Vcopy(), and WARNINGL0.

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessPointDataToFld::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "pointdatatofld"),
        ProcessPointDataToFld::create,
        "Given discrete data at quadrature points project them onto an "
        "expansion"
        "basis and output fld file. Requires frompts and .xml and .fld files.")

Definition at line 56 of file ProcessPointDataToFld.h.