Nektar::FieldUtils::ProcessFieldFromString Class Reference

This processing module adds a new field from a string definition. More...

#include <ProcessFieldFromString.h>

Inheritance diagram for Nektar::FieldUtils::ProcessFieldFromString:

Public Member Functions
	ProcessFieldFromString (FieldSharedPtr f)
virtual	~ProcessFieldFromString ()
virtual void	Process (po::variables_map &vm)
virtual std::string	GetModuleName ()
virtual std::string	GetModuleDescription ()
virtual ModulePriority	GetModulePriority ()
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)
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	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

Additional Inherited Members
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
Protected Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...

Detailed Description

This processing module adds a new field from a string definition.

Definition at line 48 of file ProcessFieldFromString.h.

Constructor & Destructor Documentation

ProcessFieldFromString()

Nektar::FieldUtils::ProcessFieldFromString::ProcessFieldFromString

(

FieldSharedPtr

f

)

Definition at line 58 of file ProcessFieldFromString.cpp.

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

    : ProcessModule(f)
{
    m_config["fieldstr"] = ConfigOption(
        false, "NotSet", "Analytic expression");
    m_config["fieldname"] =
        ConfigOption(false,
                     "newfield",
                     "name for modified new field, default is \"newfield\" (optional)");
}

~ProcessFieldFromString()

Nektar::FieldUtils::ProcessFieldFromString::~ProcessFieldFromString ( void  )

virtual

Definition at line 69 of file ProcessFieldFromString.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 52 of file ProcessFieldFromString.h.

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

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

GetModuleDescription()

virtual std::string Nektar::FieldUtils::ProcessFieldFromString::GetModuleDescription ( )

inlinevirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file ProcessFieldFromString.h.

    {
        return "Calculating new field";
    }

GetModuleName()

virtual std::string Nektar::FieldUtils::ProcessFieldFromString::GetModuleName ( )

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 63 of file ProcessFieldFromString.h.

    {
        return "ProcessFieldFromString";
    }

GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::ProcessFieldFromString::GetModulePriority ( )

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessFieldFromString.h.

References Nektar::FieldUtils::eModifyExp.

    {
        return eModifyExp;
    }

Process()

void Nektar::FieldUtils::ProcessFieldFromString::Process ( po::variables_map &  vm )

virtual

Implements Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessFieldFromString.cpp.

References ASSERTL0, Nektar::LibUtilities::Interpreter::DefineFunction(), Nektar::LibUtilities::Interpreter::Evaluate(), Nektar::StdRegions::find(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

{
    boost::ignore_unused(vm);

    // Check if required parameter fieldstr was provided
    ASSERTL0(m_config["fieldstr"].m_beenSet, "fieldstr must be specified");

    // Get number of fields (before adding new entry)
    int nfields = m_f->m_variables.size();

    // Set up new field name
    string fieldName = m_config["fieldname"].as<string>();

    int fieldID;
    bool addField;
    // check if field exists
    auto it =
        std::find(m_f->m_variables.begin(), m_f->m_variables.end(), fieldName);
    if (it != m_f->m_variables.end())
    {
        addField = false;
        fieldID = std::distance(m_f->m_variables.begin(), it);
    }
    else
    {
        // Create new expansion
        addField = true;
        fieldID  = nfields;
        m_f->m_variables.push_back(fieldName);
    }

    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }

    // Check if using strips
    int nstrips;
    m_f->m_session->LoadParameter("Strip_Z", nstrips, 1);
    ASSERTL0(nstrips == 1,
             "Routine is currently only setup for non-strip files");

    if (addField)
    {
        m_f->m_exp.resize(nfields + 1);
        m_f->m_exp[nfields] = m_f->AppendExpList(m_f->m_numHomogeneousDir);
    }

    // Variables for storing names and values for evaluating the function
    string varstr;
    vector<Array<OneD, const NekDouble> > interpfields;

    // Add the coordinate values
    varstr += "x y z";
    int npoints = m_f->m_exp[0]->GetTotPoints();
    Array<OneD, NekDouble> x(npoints, 0.0);
    Array<OneD, NekDouble> y(npoints, 0.0);
    Array<OneD, NekDouble> z(npoints, 0.0);
    m_f->m_exp[0]->GetCoords(x, y, z);
    interpfields.push_back(x);
    interpfields.push_back(y);
    interpfields.push_back(z);

    // Add the field values
    for (int i = 0; i < nfields; ++i)
    {
        varstr += " " + m_f->m_variables[i];
        interpfields.push_back(m_f->m_exp[i]->GetPhys());
    }

    // Create new function
    LibUtilities::Interpreter strEval;
    int exprId      = -1;
    string fieldstr = m_config["fieldstr"].as<string>();
    exprId          = strEval.DefineFunction(varstr.c_str(), fieldstr);

    // Evaluate function
    strEval.Evaluate(exprId, interpfields, m_f->m_exp[fieldID]->UpdatePhys());

    // Update coeffs
    m_f->m_exp[fieldID]->FwdTrans_IterPerExp(
        m_f->m_exp[fieldID]->GetPhys(), m_f->m_exp[fieldID]->UpdateCoeffs());
}

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessFieldFromString::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "fieldfromstring"),
        ProcessFieldFromString::create,
        "Modify an existing or create a new field from the existing fields as "
        "specified by a string using a required argument of the form "
        "fieldstr=\"x + y + u\" ")

Definition at line 56 of file ProcessFieldFromString.h.