Detailed Description

The ProjectData Object contains all the data needed for a certain project, i.e. all geometric data (stored in a GEOObjects-object), all the meshes, processes, and process variables.

Definition at line 35 of file Project.h.

#include <Project.h>

Collaboration diagram for DataHolderLib::Project:

[legend]

Public Member Functions
	Project ()=default
	Constructor.

	Project (Project &)=delete

	~Project ()=default

GeoLib::GEOObjects &	getGEOObjects ()
	Returns the GEOObjects containing all points, polylines and surfaces.

void	addMesh (std::unique_ptr< MeshLib::Mesh > mesh)

const MeshLib::Mesh *	getMesh (const std::string &name) const

const std::vector< std::unique_ptr< MeshLib::Mesh > > &	getMeshObjects () const
	Returns all the meshes with their respective names.

bool	removeMesh (const std::string &name)

void	addBoundaryCondition (std::unique_ptr< BoundaryCondition > bc)
	Adds a boundary condition to the project.

void	addSourceTerm (std::unique_ptr< SourceTerm > st)
	Adds a source term to the project.

std::vector< std::unique_ptr< BoundaryCondition > > const &	getBoundaryConditions () const
	Returns the vector of boundary conditions.

std::vector< std::unique_ptr< SourceTerm > > const &	getSourceTerms () const
	Returns the vector of source terms.

void	removePrimaryVariable (std::string const &primary_var_name)
	Removes a primary variable incl. all associated conditions.

void	removeBoundaryCondition (std::string const &primary_var_name, std::string const &param_name)
	Removes one boundary condition.

void	removeSourceTerm (std::string const &primary_var_name, std::string const &param_name)
	Remove one source term.

Private Member Functions
bool	getUniqueName (std::string &name) const

std::vector< std::unique_ptr< MeshLib::Mesh > >::const_iterator	findMeshByName (std::string const &name) const
	Returns an iterator to the first found mesh with the given name.

std::vector< std::unique_ptr< MeshLib::Mesh > >::iterator	findMeshByName (std::string const &name)

Private Attributes
GeoLib::GEOObjects	_geoObjects

std::vector< std::unique_ptr< MeshLib::Mesh > >	_mesh_vec

std::vector< std::unique_ptr< BoundaryCondition > >	_boundary_conditions

std::vector< std::unique_ptr< SourceTerm > >	_source_terms

Constructor & Destructor Documentation

◆ Project() [1/2]

DataHolderLib::Project::Project ( )

default

Constructor.

◆ Project() [2/2]

DataHolderLib::Project::Project ( Project & )

delete

◆ ~Project()

DataHolderLib::Project::~Project ( )

default

Member Function Documentation

◆ addBoundaryCondition()

void DataHolderLib::Project::addBoundaryCondition ( std::unique_ptr< BoundaryCondition > bc )

inline

Adds a boundary condition to the project.

Definition at line 68 of file Project.h.

    {
        _boundary_conditions.push_back(std::move(bc));
    }

References _boundary_conditions.

Referenced by FileIO::XmlPrjInterface::readBoundaryConditions().

◆ addMesh()

void DataHolderLib::Project::addMesh ( std::unique_ptr< MeshLib::Mesh > mesh )

Adds a new mesh under a (possibly new) unique name.

Attention: This might change the given mesh's name.

Definition at line 21 of file Project.cpp.

{
    std::string name = mesh->getName();
    getUniqueName(name);
    mesh->setName(name);
    _mesh_vec.push_back(std::move(mesh));
}

References _mesh_vec, and getUniqueName().

Referenced by MeshModel::addMesh(), MeshModel::addMesh(), and FileIO::XmlPrjInterface::readFile().

◆ addSourceTerm()

void DataHolderLib::Project::addSourceTerm ( std::unique_ptr< SourceTerm > st )

inline

Adds a source term to the project.

Definition at line 74 of file Project.h.

    {
        _source_terms.push_back(std::move(st));
    }

References _source_terms.

Referenced by FileIO::XmlPrjInterface::readSourceTerms().

◆ findMeshByName() [1/2]

std::vector< std::unique_ptr< MeshLib::Mesh > >::iterator DataHolderLib::Project::findMeshByName ( std::string const & name )

private

Definition at line 35 of file Project.cpp.

{
    return std::find_if(_mesh_vec.begin(), _mesh_vec.end(),
                        [&name](std::unique_ptr<MeshLib::Mesh>& mesh)
                        { return mesh && (name == mesh->getName()); });
}

References _mesh_vec.

◆ findMeshByName() [2/2]

std::vector< std::unique_ptr< MeshLib::Mesh > >::const_iterator DataHolderLib::Project::findMeshByName ( std::string const & name ) const

private

Returns an iterator to the first found mesh with the given name.

Definition at line 30 of file Project.cpp.

{
    return const_cast<Project&>(*this).findMeshByName(name);
}

References findMeshByName().

Referenced by findMeshByName(), getMesh(), and removeMesh().

◆ getBoundaryConditions()

std::vector< std::unique_ptr< BoundaryCondition > > const & DataHolderLib::Project::getBoundaryConditions ( ) const

inline

Returns the vector of boundary conditions.

Definition at line 81 of file Project.h.

    {
        return _boundary_conditions;
    }

References _boundary_conditions.

Referenced by FileIO::XmlPrjInterface::getPrimaryVariableVec(), ProcessModel::updateModel(), FileIO::XmlPrjInterface::write(), and FileIO::XmlPrjInterface::writeBoundaryConditions().

◆ getGEOObjects()

GeoLib::GEOObjects & DataHolderLib::Project::getGEOObjects ( )

inline

Returns the GEOObjects containing all points, polylines and surfaces.

Definition at line 46 of file Project.h.

46{ return _geoObjects; }

DataHolderLib::Project::_geoObjects

GeoLib::GEOObjects _geoObjects

Definition Project.h:115

References _geoObjects.

Referenced by MainWindow::MainWindow(), MainWindow::callGMSH(), MainWindow::convertMeshToGeometry(), MainWindow::convertPointsToStations(), MainWindow::exportBoreholesToGMS(), MainWindow::loadFile(), MainWindow::loadPetrelFiles(), MainWindow::mapGeometry(), FileIO::XmlPrjInterface::readFile(), MainWindow::save(), MainWindow::showGeoNameDialog(), MainWindow::showGMSHPrefsDialog(), MainWindow::showLineEditDialog(), MainWindow::showMergeGeometriesDialog(), MainWindow::showStationNameDialog(), FileIO::XmlPrjInterface::write(), MainWindow::writeGeometryToFile(), and MainWindow::writeStationListToFile().

◆ getMesh()

const MeshLib::Mesh * DataHolderLib::Project::getMesh ( const std::string & name ) const

Returns the mesh with the given name or a nullptr if the mesh was not found.

Definition at line 43 of file Project.cpp.

{
    auto it = findMeshByName(name);
    return (it == _mesh_vec.end() ? nullptr : it->get());
}

References _mesh_vec, and findMeshByName().

Referenced by MeshElementRemovalDialog::accept(), MeshElementRemovalDialog::on_scalarArrayCheckBox_toggled(), and MeshElementRemovalDialog::on_scalarArrayComboBox_currentIndexChanged().

◆ getMeshObjects()

const std::vector< std::unique_ptr< MeshLib::Mesh > > & DataHolderLib::Project::getMeshObjects ( ) const

inline

Returns all the meshes with their respective names.

Definition at line 57 of file Project.h.

    {
        return _mesh_vec;
    }

References _mesh_vec.

Referenced by MeshElementRemovalDialog::MeshElementRemovalDialog(), MeshModel::addMesh(), MeshModel::addMesh(), MainWindow::mapGeometry(), MainWindow::showMeshAnalysisDialog(), MeshModel::updateModel(), and FileIO::XmlPrjInterface::write().

◆ getSourceTerms()

std::vector< std::unique_ptr< SourceTerm > > const & DataHolderLib::Project::getSourceTerms ( ) const

inline

Returns the vector of source terms.

Definition at line 87 of file Project.h.

    {
        return _source_terms;
    }

References _source_terms.

Referenced by FileIO::XmlPrjInterface::getPrimaryVariableVec(), ProcessModel::updateModel(), FileIO::XmlPrjInterface::write(), and FileIO::XmlPrjInterface::writeSourceTerms().

◆ getUniqueName()

bool DataHolderLib::Project::getUniqueName ( std::string & name ) const

private

Checks if a mesh with the same name exists and provides a unique name in case of already existing mesh. Returns true if the mesh name is unique. Returns false and changes the provided name to a unique name otherwise.

Definition at line 61 of file Project.cpp.

{
    int count(0);
    bool isUnique(false);
    std::string cpName;
 
    while (!isUnique)
    {
        isUnique = true;
        cpName = name;
 
        count++;
        // If the original name already exists we start to add numbers to name
        // for as long as it takes to make the name unique.
        if (count > 1)
        {
            cpName = cpName + "-" + std::to_string(count);
        }
 
        for (auto const& mesh : _mesh_vec)
        {
            if (cpName == mesh->getName())
            {
                isUnique = false;
            }
        }
    }
 
    // At this point cpName is a unique name and isUnique is true.
    // If cpName is not the original name, "name" is changed and isUnique is set
    // to false, indicating that a vector with the original name already exists.
    if (count > 1)
    {
        isUnique = false;
        name = cpName;
    }
    return isUnique;
}

References _mesh_vec.

Referenced by addMesh().

◆ removeBoundaryCondition()

void DataHolderLib::Project::removeBoundaryCondition	(	std::string const &	primary_var_name,
		std::string const &	param_name )

Removes one boundary condition.

Definition at line 123 of file Project.cpp.

{
    std::size_t const n_bc(_boundary_conditions.size());
    for (std::size_t i = 0; i < n_bc; ++i)
    {
        if (_boundary_conditions[i]->getProcessVarName() == primary_var_name &&
            _boundary_conditions[i]->getParamName() == param_name)
        {
            _boundary_conditions[i].reset();
            _boundary_conditions.erase(_boundary_conditions.begin() + i);
            return;
        }
    }
}

References _boundary_conditions.

Referenced by ProcessModel::removeCondition(), and removePrimaryVariable().

◆ removeMesh()

bool DataHolderLib::Project::removeMesh ( const std::string & name )

Deletes all meshes with the given name and removes them from the list of saved meshes. If any mesh was found for removal, true is returned and false otherwise.

Definition at line 49 of file Project.cpp.

{
    auto it = findMeshByName(name);
    if (it != _mesh_vec.end())
    {
        delete it->release();
        _mesh_vec.erase(it);
        return true;
    }
    return false;
}

References _mesh_vec, and findMeshByName().

Referenced by MeshModel::removeMesh().

◆ removePrimaryVariable()

void DataHolderLib::Project::removePrimaryVariable ( std::string const & primary_var_name )

Removes a primary variable incl. all associated conditions.

Definition at line 100 of file Project.cpp.

{
    std::size_t const n_bc(_boundary_conditions.size());
    for (int i = n_bc - 1; i >= 0; --i)
    {
        if (_boundary_conditions[i]->getProcessVarName() == primary_var_name)
        {
            removeBoundaryCondition(primary_var_name,
                                    _boundary_conditions[i]->getParamName());
        }
    }
 
    std::size_t const n_st(_source_terms.size());
    for (int i = n_st - 1; i >= 0; --i)
    {
        if (_source_terms[i]->getProcessVarName() == primary_var_name)
        {
            removeSourceTerm(primary_var_name,
                             _source_terms[i]->getParamName());
        }
    }
}

References _boundary_conditions, _source_terms, removeBoundaryCondition(), and removeSourceTerm().

Referenced by ProcessModel::removeProcessVariable().

◆ removeSourceTerm()

void DataHolderLib::Project::removeSourceTerm	(	std::string const &	primary_var_name,
		std::string const &	param_name )

Remove one source term.

Definition at line 139 of file Project.cpp.

{
    std::size_t const n_st(_source_terms.size());
    for (std::size_t i = 0; i < n_st; ++i)
    {
        if (_source_terms[i]->getProcessVarName() == primary_var_name &&
            _source_terms[i]->getParamName() == param_name)
        {
            _source_terms[i].reset();
            _source_terms.erase(_source_terms.begin() + i);
            return;
        }
    }
}

References _source_terms.

Referenced by ProcessModel::removeCondition(), and removePrimaryVariable().

Member Data Documentation

◆ _boundary_conditions

std::vector<std::unique_ptr<BoundaryCondition> > DataHolderLib::Project::_boundary_conditions

private

Definition at line 117 of file Project.h.

Referenced by addBoundaryCondition(), getBoundaryConditions(), removeBoundaryCondition(), and removePrimaryVariable().

◆ _geoObjects

GeoLib::GEOObjects DataHolderLib::Project::_geoObjects

private

Definition at line 115 of file Project.h.

Referenced by getGEOObjects().

◆ _mesh_vec

std::vector<std::unique_ptr<MeshLib::Mesh> > DataHolderLib::Project::_mesh_vec

private

Definition at line 116 of file Project.h.

Referenced by addMesh(), findMeshByName(), getMesh(), getMeshObjects(), getUniqueName(), and removeMesh().

◆ _source_terms

std::vector<std::unique_ptr<SourceTerm> > DataHolderLib::Project::_source_terms

private

Definition at line 118 of file Project.h.

Referenced by addSourceTerm(), getSourceTerms(), removePrimaryVariable(), and removeSourceTerm().

The documentation for this class was generated from the following files:

Applications/DataHolderLib/Project.h
Applications/DataHolderLib/Project.cpp

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ Project() [1/2]

◆ Project() [2/2]

◆ ~Project()

Member Function Documentation

◆ addBoundaryCondition()

◆ addMesh()

◆ addSourceTerm()

◆ findMeshByName() [1/2]

◆ findMeshByName() [2/2]

◆ getBoundaryConditions()

◆ getGEOObjects()

◆ getMesh()

◆ getMeshObjects()

◆ getSourceTerms()

◆ getUniqueName()

◆ removeBoundaryCondition()

◆ removeMesh()

◆ removePrimaryVariable()

◆ removeSourceTerm()

Member Data Documentation

◆ _boundary_conditions

◆ _geoObjects

◆ _mesh_vec

◆ _source_terms