Nektar::Utilities::ProcessBoundaryExtract Class Reference

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

#include <ProcessBoundaryExtract.h>

Inheritance diagram for Nektar::Utilities::ProcessBoundaryExtract:

Collaboration diagram for Nektar::Utilities::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::Utilities::ProcessModule
	ProcessModule ()
	ProcessModule (FieldSharedPtr p_f)
	ProcessModule (MeshSharedPtr p_m)
Public Member Functions inherited from Nektar::Utilities::Module
	Module (FieldSharedPtr p_f)
void	RegisterConfig (string key, string value)
	Register a configuration option with a module. More...
void	PrintConfig ()
	Print out all configuration options for a module. More...
void	SetDefaults ()
	Sets default configuration options for those which have not been set. More...
bool	GetRequireEquiSpaced (void)
void	SetRequireEquiSpaced (bool pVal)
void	EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)
	Module (MeshSharedPtr p_m)
virtual void	Process ()=0
void	RegisterConfig (std::string key, std::string value)
void	PrintConfig ()
void	SetDefaults ()
MeshSharedPtr	GetMesh ()
virtual void	ProcessVertices ()
	Extract element vertices. More...
virtual void	ProcessEdges (bool ReprocessEdges=true)
	Extract element edges. More...
virtual void	ProcessFaces (bool ReprocessFaces=true)
	Extract element faces. More...
virtual void	ProcessElements ()
	Generate element IDs. More...
virtual void	ProcessComposites ()
	Generate composites. More...
virtual void	ClearElementLinks ()

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::Utilities::Module
	Module ()
void	ReorderPrisms (PerMap &perFaces)
	Reorder node IDs so that prisms and tetrahedra are aligned correctly. More...
void	PrismLines (int prism, PerMap &perFaces, std::set< int > &prismsDone, std::vector< ElementSharedPtr > &line)
Protected Attributes inherited from Nektar::Utilities::Module
FieldSharedPtr	m_f
	Field object. More...
map< string, ConfigOption >	m_config
	List of configuration values. More...
bool	m_requireEquiSpaced
MeshSharedPtr	m_mesh
	Mesh object. More...
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...

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::Utilities::ProcessBoundaryExtract::ProcessBoundaryExtract

(

FieldSharedPtr

f

)

Definition at line 55 of file ProcessBoundaryExtract.cpp.

References Nektar::Utilities::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::Utilities::ProcessBoundaryExtract::~ProcessBoundaryExtract ( )

virtual

Definition at line 69 of file ProcessBoundaryExtract.cpp.

{
}

Member Function Documentation

static boost::shared_ptr<Module> Nektar::Utilities::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::Utilities::ProcessBoundaryExtract::GetModuleName ( )

inlinevirtual

Implements Nektar::Utilities::Module.

Definition at line 63 of file ProcessBoundaryExtract.h.

        {
            return "ProcessBoundaryExtract";
        }

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

virtual

Implements Nektar::Utilities::Module.

Definition at line 73 of file ProcessBoundaryExtract.cpp.

References ASSERTL0, Nektar::ParseUtils::GenerateOrderedVector(), Nektar::SpatialDomains::BoundaryConditions::GetBoundaryRegions(), Nektar::Utilities::Module::m_config, Nektar::Utilities::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::Utilities::ProcessBoundaryExtract::className

static

Initial value:

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

Definition at line 56 of file ProcessBoundaryExtract.h.