weipa/src/SpeckleyDomain.h
Go to the documentation of this file.
/*****************************************************************************
*
* Copyright (c) 2003-2017 by The University of Queensland
* http://www.uq.edu.au
*
* Primary Business: Queensland, Australia
* Licensed under the Apache License, version 2.0
* http://www.apache.org/licenses/LICENSE-2.0
*
* Development until 2012 by Earth Systems Science Computational Center (ESSCC)
* Development 2012-2013 by School of Earth Sciences
* Development from 2014 by Centre for Geoscience Computing (GeoComp)
*
*****************************************************************************/
#ifndef __WEIPA_SPECKLEYDOMAIN_H__
#define __WEIPA_SPECKLEYDOMAIN_H__
#include <weipa/DomainChunk.h>
#include <weipa/SpeckleyElements.h>
#include <boost/enable_shared_from_this.hpp>
namespace weipa {
class SpeckleyDomain : public DomainChunk, public boost::enable_shared_from_this<SpeckleyDomain>
{
public:
SpeckleyDomain();
SpeckleyDomain(const SpeckleyDomain& m);
virtual ~SpeckleyDomain() {}
virtual bool initFromEscript(const escript::AbstractDomain* domain);
virtual bool initFromFile(const std::string& filename);
virtual bool writeToSilo(DBfile* dbfile, const std::string& pathInSilo,
const StringVec& labels, const StringVec& units,
bool writeMeshData);
virtual void reorderGhostZones(int ownIndex);
virtual void removeGhostZones(int ownIndex);
virtual StringVec getMeshNames() const;
virtual StringVec getVarNames() const;
virtual ElementData_ptr getElementsByName(const std::string& name) const;
virtual NodeData_ptr getMeshByName(const std::string& name) const;
virtual DataVar_ptr getDataVarByName(const std::string& name) const;
virtual Centering getCenteringForFunctionSpace(int fsCode) const;
virtual NodeData_ptr getMeshForFunctionSpace(int fsCode) const;
virtual ElementData_ptr getElementsForFunctionSpace(int fsCode) const;
virtual NodeData_ptr getNodes() const { return nodes; }
virtual std::string getSiloPath() const { return siloPath; }
virtual void setSiloPath(const std::string& path) { siloPath = path; }
private:
bool initialized;
SpeckleyNodes_ptr nodes;
SpeckleyElements_ptr cells;
SpeckleyElements_ptr faces;
std::string siloPath;
};
} // namespace weipa
#endif // __WEIPA_SPECKLEYDOMAIN_H__
weipa::SpeckleyDomain::nodes
SpeckleyNodes_ptr nodes
Definition: weipa/src/SpeckleyDomain.h:62
weipa::SpeckleyDomain
Represents a full Speckley domain including nodes and elements.
Definition: weipa/src/SpeckleyDomain.h:35
weipa::SpeckleyDomain::cells
SpeckleyElements_ptr cells
Definition: weipa/src/SpeckleyDomain.h:63
weipa::SpeckleyDomain::getCenteringForFunctionSpace
virtual Centering getCenteringForFunctionSpace(int fsCode) const
Returns whether data on given function space is node or cell centered.
Definition: weipa/src/SpeckleyDomain.cpp:74
weipa::SpeckleyDomain::getVarNames
virtual StringVec getVarNames() const
Returns the names of all &#39;special&#39; domain variables.
Definition: weipa/src/SpeckleyDomain.cpp:141
weipa::SpeckleyDomain::removeGhostZones
virtual void removeGhostZones(int ownIndex)
Removes &#39;ghost&#39; elements and nodes.
Definition: weipa/src/SpeckleyDomain.cpp:216
weipa::SpeckleyDomain::initFromFile
virtual bool initFromFile(const std::string &filename)
Reads the domain from a dump file.
Definition: weipa/src/SpeckleyDomain.cpp:68
weipa::StringVec
std::vector< std::string > StringVec
Definition: weipa.h:60
weipa::SpeckleyDomain::initFromEscript
virtual bool initFromEscript(const escript::AbstractDomain *domain)
Initialises the domain using an escript domain instance.
Definition: weipa/src/SpeckleyDomain.cpp:49
weipa::SpeckleyDomain::getMeshForFunctionSpace
virtual NodeData_ptr getMeshForFunctionSpace(int fsCode) const
Returns the node mesh for given function space code.
Definition: weipa/src/SpeckleyDomain.cpp:80
weipa::SpeckleyDomain::SpeckleyDomain
SpeckleyDomain()
Definition: weipa/src/SpeckleyDomain.cpp:35
weipa::SpeckleyDomain::siloPath
std::string siloPath
Definition: weipa/src/SpeckleyDomain.h:65
weipa::SpeckleyDomain::getNodes
virtual NodeData_ptr getNodes() const
Returns a pointer to the full nodes.
Definition: weipa/src/SpeckleyDomain.h:56
weipa::SpeckleyDomain::getElementsByName
virtual ElementData_ptr getElementsByName(const std::string &name) const
Returns element data with given name.
Definition: weipa/src/SpeckleyDomain.cpp:188
weipa::SpeckleyDomain::reorderGhostZones
virtual void reorderGhostZones(int ownIndex)
Reorders elements so that &#39;ghost&#39; elements (i.e. those that do not belong to ownIndex) appear last...
Definition: weipa/src/SpeckleyDomain.cpp:211
weipa::SpeckleyDomain::getMeshNames
virtual StringVec getMeshNames() const
Returns the names of all meshes within this domain.
Definition: weipa/src/SpeckleyDomain.cpp:125
weipa
Definition: DataVar.cpp:50
weipa::DomainChunk
Abstract base class for weipa&#39;s interface to an Escript domain or one chunk thereof if domain decompo...
Definition: DomainChunk.h:45
weipa::SpeckleyDomain::getElementsForFunctionSpace
virtual ElementData_ptr getElementsForFunctionSpace(int fsCode) const
Returns the element data for given function space code.
Definition: weipa/src/SpeckleyDomain.cpp:96
weipa::SpeckleyDomain::initialized
bool initialized
Definition: weipa/src/SpeckleyDomain.h:61
weipa::DataVar_ptr
boost::shared_ptr< DataVar > DataVar_ptr
Definition: weipa.h:64
weipa::SpeckleyDomain::writeToSilo
virtual bool writeToSilo(DBfile *dbfile, const std::string &pathInSilo, const StringVec &labels, const StringVec &units, bool writeMeshData)
Writes the domain to a Silo file.
Definition: weipa/src/SpeckleyDomain.cpp:221
weipa::SpeckleyElements_ptr
boost::shared_ptr< SpeckleyElements > SpeckleyElements_ptr
Definition: SpeckleyElements.h:32
weipa::Centering
Centering
Definition: DomainChunk.h:30
weipa::SpeckleyDomain::getDataVarByName
virtual DataVar_ptr getDataVarByName(const std::string &name) const
Creates and returns a variable with domain data.
Definition: weipa/src/SpeckleyDomain.cpp:156
weipa::SpeckleyNodes_ptr
boost::shared_ptr< SpeckleyNodes > SpeckleyNodes_ptr
Definition: SpeckleyNodes.h:30
weipa::ElementData_ptr
boost::shared_ptr< ElementData > ElementData_ptr
Definition: weipa.h:66
weipa::SpeckleyDomain::faces
SpeckleyElements_ptr faces
Definition: weipa/src/SpeckleyDomain.h:64
weipa::SpeckleyDomain::setSiloPath
virtual void setSiloPath(const std::string &path)
Sets the silo path to be used when saving to a Silo file.
Definition: weipa/src/SpeckleyDomain.h:58
escript::AbstractDomain
Base class for all escript domains.
Definition: AbstractDomain.h:45
weipa::SpeckleyDomain::getSiloPath
virtual std::string getSiloPath() const
Returns the absolute path within Silo file if writeToSilo() or setSiloPath() was called before...
Definition: weipa/src/SpeckleyDomain.h:57
weipa::SpeckleyDomain::~SpeckleyDomain
virtual ~SpeckleyDomain()
Definition: weipa/src/SpeckleyDomain.h:40
weipa::NodeData_ptr
boost::shared_ptr< NodeData > NodeData_ptr
Definition: weipa.h:68
weipa::SpeckleyDomain::getMeshByName
virtual NodeData_ptr getMeshByName(const std::string &name) const
Returns the node mesh with given name.
Definition: weipa/src/SpeckleyDomain.cpp:199