Nektar::FieldUtils::ProcessBoundaryExtract Class Reference

This processing module sets up for the boundary field to be extracted. More...

#include <ProcessBoundaryExtract.h>

Inheritance diagram for Nektar::FieldUtils::ProcessBoundaryExtract:

Collaboration diagram for Nektar::FieldUtils::ProcessBoundaryExtract:

Public Member Functions
	ProcessBoundaryExtract (FieldSharedPtr f)
virtual	~ProcessBoundaryExtract ()
virtual void	Process (po::variables_map &vm)
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 sets up for the boundary field to be extracted.

Definition at line 49 of file ProcessBoundaryExtract.h.

Constructor & Destructor Documentation

Nektar::FieldUtils::ProcessBoundaryExtract::ProcessBoundaryExtract

(

FieldSharedPtr

f

)

Definition at line 56 of file ProcessBoundaryExtract.cpp.

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

    : ProcessModule(f)
{
    // set up dafault values.
    m_config["bnd"] = ConfigOption(false, "All", "Boundary to be extracted");
    m_config["fldtoboundary"] =
        ConfigOption(true, "NotSet", "Extract fld values to boundary");
    m_config["addnormals"] =
        ConfigOption(true, "NotSet", "Add normals to output");

    f->m_writeBndFld                 = true;
    f->m_declareExpansionAsContField = true;
    f->m_requireBoundaryExpansion    = true;
}

Nektar::FieldUtils::ProcessBoundaryExtract::~ProcessBoundaryExtract ( )

virtual

Definition at line 71 of file ProcessBoundaryExtract.cpp.

{
}

Member Function Documentation

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

inlinestatic

Creates an instance of this class.

Definition at line 53 of file ProcessBoundaryExtract.h.

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

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

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

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessBoundaryExtract.h.

    {
        return "ProcessBoundaryExtract";
    }

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

virtual

Implements Nektar::FieldUtils::Module.

Definition at line 75 of file ProcessBoundaryExtract.cpp.

References ASSERTL0, Nektar::ParseUtils::GenerateOrderedVector(), Nektar::SpatialDomains::BoundaryConditions::GetBoundaryRegions(), Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, and Nektar::LibUtilities::ReduceMax.

{
    if (m_f->m_verbose)
    {
        if (m_f->m_comm->TreatAsRankZero())
        {
            cout << "ProcessBoundaryExtract: Setting up boundary extraction..."
                 << endl;
        }
    }

    m_f->m_fldToBnd   = m_config["fldtoboundary"].m_beenSet;
    m_f->m_addNormals = m_config["addnormals"].m_beenSet;

    // check for correct input files
    if ((m_f->m_inputfiles.count("xml") == 0) &&
        (m_f->m_inputfiles.count("xml.gz") == 0))
    {
        cout << "An xml or xml.gz input file must be specified for the "
                "boundary extraction module"
             << endl;
        exit(3);
    }

    if (m_f->m_fldToBnd)
    {
        if ((m_f->m_inputfiles.count("fld") == 0) &&
            (m_f->m_inputfiles.count("chk") == 0) &&
            (m_f->m_inputfiles.count("rst") == 0))
        {
            cout << "A fld or chk or rst input file must be specified for "
                 << "the boundary extraction module with fldtoboundary option."
                 << endl;

            exit(3);
        }
    }

    // Set up Field options to output boundary fld
    string bvalues = m_config["bnd"].as<string>();

    if (boost::iequals(bvalues, "All"))
    {
        int numBndExp = 0;

        SpatialDomains::BoundaryConditions bcs(m_f->m_session,
                                               m_f->m_exp[0]->GetGraph());
        const SpatialDomains::BoundaryRegionCollection bregions =
            bcs.GetBoundaryRegions();

        SpatialDomains::BoundaryRegionCollection::const_iterator breg_it;
        for (breg_it = bregions.begin(); breg_it != bregions.end(); ++breg_it)
        {
            numBndExp = max(numBndExp, breg_it->first);
        }
        // assuming all boundary regions are consecutive number if
        // regions is one more tham maximum id
        numBndExp++;

        // not all partitions in parallel touch all boundaries so
        // find maximum number of boundaries
        m_f->m_session->GetComm()->AllReduce(numBndExp,
                                             LibUtilities::ReduceMax);

        // THis presumes boundary regions are numbered consecutively
        for (int i = 0; i < numBndExp; ++i)
        {
            m_f->m_bndRegionsToWrite.push_back(i);
        }
    }
    else
    {
        ASSERTL0(ParseUtils::GenerateOrderedVector(bvalues.c_str(),
                                                   m_f->m_bndRegionsToWrite),
                 "Failed to interpret bnd values string");
    }
}

Member Data Documentation

ModuleKey Nektar::FieldUtils::ProcessBoundaryExtract::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "extract"),
        ProcessBoundaryExtract::create,
        "Extract Boundary field")

Definition at line 57 of file ProcessBoundaryExtract.h.