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:

Public Member Functions
	ProcessBoundaryExtract (FieldSharedPtr f)
virtual	~ProcessBoundaryExtract ()
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)
virtual	~Module ()=default
const ConfigOption &	GetConfigOption (const std::string &key) const
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

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
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 sets up for the boundary field to be extracted.

Definition at line 48 of file ProcessBoundaryExtract.h.

Constructor & Destructor Documentation

ProcessBoundaryExtract()

Nektar::FieldUtils::ProcessBoundaryExtract::ProcessBoundaryExtract

(

FieldSharedPtr

f

)

Definition at line 56 of file ProcessBoundaryExtract.cpp.

    : ProcessModule(f)
{
    // set up dafault values.
    m_config["bnd"] = ConfigOption(false, "All", "Boundary to be processed");
    m_config["addnormals"] = ConfigOption(true, "0", "Add normals to output");
 
    f->m_writeBndFld                 = true;
    f->m_declareExpansionAsContField = true;
    f->m_requireBoundaryExpansion    = true;
}

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

~ProcessBoundaryExtract()

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

virtual

Definition at line 68 of file ProcessBoundaryExtract.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 52 of file ProcessBoundaryExtract.h.

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

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

GetModuleDescription()

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

inlinevirtual

Reimplemented from Nektar::FieldUtils::Module.

Reimplemented in Nektar::FieldUtils::ProcessWSS, Nektar::FieldUtils::ProcessWallNormalData, Nektar::FieldUtils::ProcessSurfDistance, Nektar::FieldUtils::ProcessScalGrad, and Nektar::FieldUtils::ProcessDisplacement.

Definition at line 68 of file ProcessBoundaryExtract.h.

    {
        return "Setting up boundary extraction";
    }

GetModuleName()

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

inlinevirtual

Implements Nektar::FieldUtils::Module.

Reimplemented in Nektar::FieldUtils::ProcessWSS, Nektar::FieldUtils::ProcessWallNormalData, Nektar::FieldUtils::ProcessSurfDistance, Nektar::FieldUtils::ProcessScalGrad, and Nektar::FieldUtils::ProcessDisplacement.

Definition at line 63 of file ProcessBoundaryExtract.h.

    {
        return "ProcessBoundaryExtract";
    }

GetModulePriority()

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

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessBoundaryExtract.h.

    {
        return eBndExtraction;
    }

References Nektar::FieldUtils::eBndExtraction.

Process()

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

virtual

Implements Nektar::FieldUtils::Module.

Reimplemented in Nektar::FieldUtils::ProcessWSS, Nektar::FieldUtils::ProcessWallNormalData, Nektar::FieldUtils::ProcessSurfDistance, Nektar::FieldUtils::ProcessScalGrad, and Nektar::FieldUtils::ProcessDisplacement.

Definition at line 72 of file ProcessBoundaryExtract.cpp.

{
    m_f->SetUpExp(vm);
 
    m_f->m_addNormals = m_config["addnormals"].as<bool>();
 
    // Set up Field options to output boundary fld
    string bvalues = m_config["bnd"].as<string>();
 
    vector<unsigned int> bndRegions;
    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();
 
        for (auto &breg_it : bregions)
        {
            numBndExp = max(numBndExp, breg_it.first);
        }
        // assuming all boundary regions are consecutive number if
        // regions is one more than maximum id
        numBndExp++;
 
        // not all partitions in parallel touch all boundaries so
        // find maximum number of boundaries
        m_f->m_comm->AllReduce(numBndExp, LibUtilities::ReduceMax);
 
        // THis presumes boundary regions are numbered consecutively
        for (int i = 0; i < numBndExp; ++i)
        {
            bndRegions.push_back(i);
        }
    }
    else
    {
        ASSERTL0(ParseUtils::GenerateVector(bvalues, bndRegions),
                 "Failed to interpret bnd values string");
    }
 
    if (m_f->m_bndRegionsToWrite.size())
    {
        // This was already called. Just check if the bnd option is the same
        ASSERTL0(m_f->m_bndRegionsToWrite == bndRegions,
                 "Incompatible bnd parameters.");
    }
    else
    {
        m_f->m_bndRegionsToWrite = bndRegions;
 
        if (m_f->m_exp[0]->GetNumElmts() != 0)
        {
            for (int i = 0; i < m_f->m_exp.size(); ++i)
            {
                m_f->m_exp[i]->FillBndCondFromField();
            }
        }
    }
}

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

Referenced by Nektar::FieldUtils::ProcessDisplacement::Process(), Nektar::FieldUtils::ProcessScalGrad::Process(), Nektar::FieldUtils::ProcessSurfDistance::Process(), Nektar::FieldUtils::ProcessWallNormalData::Process(), and Nektar::FieldUtils::ProcessWSS::Process().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessBoundaryExtract::className

static

Initial value:

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

Definition at line 56 of file ProcessBoundaryExtract.h.