Nektar::FieldUtils::ProcessHomogeneousPlane Class Reference

This processing module replaces all expansions by a single plane from 3DH1D fields, defined by the parameter planeid. More...

#include <ProcessHomogeneousPlane.h>

Inheritance diagram for Nektar::FieldUtils::ProcessHomogeneousPlane:

Collaboration diagram for Nektar::FieldUtils::ProcessHomogeneousPlane:

Public Member Functions
	ProcessHomogeneousPlane (FieldSharedPtr f)
virtual	~ProcessHomogeneousPlane ()
virtual void	Process (po::variables_map &vm)
	Write mesh to output file. More...
virtual std::string	GetModuleName ()
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 (string key, 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 bool	GetRequireEquiSpaced (void)
FIELD_UTILS_EXPORT void	SetRequireEquiSpaced (bool pVal)
FIELD_UTILS_EXPORT void	EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)

Static Public Member Functions
static boost::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...
map< string, ConfigOption >	m_config
	List of configuration values. More...
bool	m_requireEquiSpaced

Detailed Description

This processing module replaces all expansions by a single plane from 3DH1D fields, defined by the parameter planeid.

Definition at line 50 of file ProcessHomogeneousPlane.h.

Constructor & Destructor Documentation

Nektar::FieldUtils::ProcessHomogeneousPlane::ProcessHomogeneousPlane

(

FieldSharedPtr

f

)

Definition at line 57 of file ProcessHomogeneousPlane.cpp.

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

    : ProcessModule(f)
{
    m_config["planeid"] = ConfigOption(false, "NotSet", "plane id to extract");
    m_config["wavespace"] =
        ConfigOption(true, "NotSet", "Extract plane in Fourier space");
}

Nektar::FieldUtils::ProcessHomogeneousPlane::~ProcessHomogeneousPlane ( )

virtual

Definition at line 65 of file ProcessHomogeneousPlane.cpp.

{
}

Member Function Documentation

static boost::shared_ptr<Module> Nektar::FieldUtils::ProcessHomogeneousPlane::create ( FieldSharedPtr  f )

inlinestatic

Creates an instance of this class.

Definition at line 54 of file ProcessHomogeneousPlane.h.

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

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

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

inlinevirtual

Implements Nektar::FieldUtils::Module.

Reimplemented in Nektar::FieldUtils::ProcessMeanMode.

Definition at line 66 of file ProcessHomogeneousPlane.h.

    {
        return "ProcessScalGrad";
    }

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

virtual

Write mesh to output file.

Implements Nektar::FieldUtils::Module.

Reimplemented in Nektar::FieldUtils::ProcessMeanMode.

Definition at line 69 of file ProcessHomogeneousPlane.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

Referenced by Nektar::FieldUtils::ProcessMeanMode::Process().

{
    if (m_f->m_verbose)
    {
        if (m_f->m_comm->TreatAsRankZero())
        {
            cout << "ProcessHomogeneousPlane: Extracting plane..." << endl;
        }
    }

    if ((m_f->m_fielddef[0]->m_numHomogeneousDir) != 1)
    {
        ASSERTL0(false,
                 "ProcessHomogeneousPlane only works for Homogeneous1D.");
    }

    ASSERTL0(m_config["planeid"].m_beenSet,
             "Missing parameter planeid for ProcessHomogeneousPlane");

    int planeid = m_config["planeid"].as<int>();
    int nfields = m_f->m_fielddef[0]->m_fields.size();

    int nstrips;
    m_f->m_session->LoadParameter("Strip_Z", nstrips, 1);

    // Look for correct plane (because of parallel case)
    int plane = -1;
    for (int i = 0; i < m_f->m_fielddef[0]->m_homogeneousZIDs.size(); ++i)
    {
        if (m_f->m_fielddef[0]->m_homogeneousZIDs[i] == planeid)
        {
            plane = i;
        }
    }

    if (plane != -1)
    {
        for (int s = 0; s < nstrips; ++s)
        {
            for (int i = 0; i < nfields; ++i)
            {
                int n         = s * nfields + i;
                m_f->m_exp[n] = m_f->m_exp[n]->GetPlane(plane);

                if (m_config["wavespace"].m_beenSet)
                {
                    m_f->m_exp[n]->BwdTrans(m_f->m_exp[n]->GetCoeffs(),
                                            m_f->m_exp[n]->UpdatePhys());
                }
                else
                {
                    m_f->m_exp[n]->FwdTrans(m_f->m_exp[n]->GetPhys(),
                                            m_f->m_exp[n]->UpdateCoeffs());
                }
            }
        }
        std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
            m_f->m_exp[0]->GetFieldDefinitions();
        std::vector<std::vector<NekDouble> > FieldData(FieldDef.size());

        for (int s = 0; s < nstrips; ++s)
        {
            for (int j = 0; j < nfields; ++j)
            {
                for (int i = 0; i < FieldDef.size() / nstrips; ++i)
                {
                    int n = s * FieldDef.size() / nstrips + i;

                    FieldDef[n]->m_fields.push_back(
                        m_f->m_fielddef[0]->m_fields[j]);
                    m_f->m_exp[s * nfields + j]->AppendFieldData(FieldDef[n],
                                                                 FieldData[n]);
                }
            }
        }

        m_f->m_fielddef = FieldDef;
        m_f->m_data     = FieldData;
    }
    else
    {
        for (int s = 0; s < nstrips; ++s)
        {
            for (int i = 0; i < nfields; ++i)
            {
                int n = s * nfields + i;
                m_f->m_exp[n] =
                    MemoryManager<MultiRegions::ExpList>::AllocateSharedPtr();
            }
        }
        m_f->m_fielddef =
            std::vector<LibUtilities::FieldDefinitionsSharedPtr>();
        m_f->m_data = std::vector<std::vector<NekDouble> >();
    }
}

Member Data Documentation

ModuleKey Nektar::FieldUtils::ProcessHomogeneousPlane::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "homplane"),
        ProcessHomogeneousPlane::create,
        "Extracts a plane from a 3DH1D expansion, requires planeid to be "
        "defined.")

Definition at line 58 of file ProcessHomogeneousPlane.h.