feat: Add ExternalDataRepository #2957
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * ------------------------------------------------------------------------------------------------------------ | ||
| * SPDX-License-Identifier: LGPL-2.1-only | ||
| * | ||
| * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC | ||
| * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University | ||
| * Copyright (c) 2018-2020 TotalEnergies | ||
| * Copyright (c) 2019- GEOSX Contributors | ||
| * All rights reserved | ||
| * | ||
| * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details. | ||
| * ------------------------------------------------------------------------------------------------------------ | ||
| */ | ||
|
|
||
| #include "ExternalDataRepositoryBase.hpp" | ||
|
|
||
| namespace geos | ||
| { | ||
| using namespace dataRepository; | ||
|
|
||
| ExternalDataRepositoryBase::ExternalDataRepositoryBase( string const & name, Group * const parent ): | ||
| Group( name, parent ) | ||
| { | ||
| setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); | ||
| } | ||
|
|
||
| Group * ExternalDataRepositoryBase::createChild( string const & childKey, string const & childName ) | ||
| { | ||
| GEOS_LOG_RANK_0( "Adding External Data Repository: " << childKey << ", " << childName ); | ||
| std::unique_ptr< ExternalDataRepositoryBase > event = ExternalDataRepositoryBase::CatalogInterface::factory( childKey, childName, this ); | ||
| return &this->registerGroup< ExternalDataRepositoryBase >( childName, std::move( event ) ); | ||
| } | ||
|
|
||
| void ExternalDataRepositoryBase::expandObjectCatalogs() | ||
| { | ||
| // Only add children if the parent is of type EventManager | ||
| // otherwise, this would fall into a loop | ||
| if( strcmp( this->getParent().getName().c_str(), "ExternalDataRepository" ) == 0 ) | ||
| { | ||
| for( auto & catalogIter: ExternalDataRepositoryBase::getCatalog()) | ||
| { | ||
| createChild( catalogIter.first, catalogIter.first ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| ExternalDataRepositoryBase::CatalogInterface::CatalogType & ExternalDataRepositoryBase::getCatalog() | ||
| { | ||
| static ExternalDataRepositoryBase::CatalogInterface::CatalogType catalog; | ||
| return catalog; | ||
| } | ||
|
|
||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * ------------------------------------------------------------------------------------------------------------ | ||
| * SPDX-License-Identifier: LGPL-2.1-only | ||
| * | ||
| * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC | ||
| * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University | ||
| * Copyright (c) 2018-2020 TotalEnergies | ||
| * Copyright (c) 2019- GEOSX Contributors | ||
| * All rights reserved | ||
| * | ||
| * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details. | ||
| * ------------------------------------------------------------------------------------------------------------ | ||
| */ | ||
|
|
||
| /** | ||
| * @file ExternalDataRepositoryBase.hpp | ||
| */ | ||
|
|
||
| #ifndef GEOS_MESH_EXTERNALDATAREPOSITORYBASE_HPP | ||
| #define GEOS_MESH_EXTERNALDATAREPOSITORYBASE_HPP | ||
|
|
||
| #include "dataRepository/Group.hpp" | ||
| #include "dataRepository/WrapperBase.hpp" | ||
| #include "codingUtilities/Utilities.hpp" | ||
| #include "common/DataTypes.hpp" | ||
|
|
||
|
|
||
| namespace geos | ||
| { | ||
|
|
||
| /** | ||
| * @class ExternalDataRepositoryBase | ||
| * @brief The ExternalDataRepositoryBase class provides an abstract base class implementation for different mesh types. | ||
| * The ExternalDataRepositoryBase is the Group specialization for different type of mesh handling. | ||
| */ | ||
| class ExternalDataRepositoryBase : public dataRepository::Group | ||
| { | ||
| public: | ||
|
|
||
| /** | ||
| * @brief Main constructor for ExternalDataRepositoryBase base class. | ||
| * @param[in] name of the ExternalDataRepositoryBase object | ||
| * @param[in] parent the parent Group pointer for the ExternalDataRepositoryBase object | ||
| */ | ||
| explicit ExternalDataRepositoryBase( string const & name, | ||
| Group * const parent ); | ||
|
|
||
| /// This function is used to expand any catalogs in the data structure | ||
| virtual void expandObjectCatalogs() override; | ||
|
|
||
| /// using alias for templated Catalog ExternalDataRepositoryBase type | ||
| using CatalogInterface = dataRepository::CatalogInterface< ExternalDataRepositoryBase, string const &, Group * const >; | ||
|
|
||
| /** | ||
| * @brief Create a new geometric object (box, plane, etc) as a child of this group. | ||
| * @param childKey the catalog key of the new geometric object to create | ||
| * @param childName the name of the new geometric object in the repository | ||
| * @return the group child | ||
| */ | ||
| virtual Group * createChild( string const & childKey, string const & childName ) override; | ||
|
|
||
| /** | ||
| * @brief Accessor for the singleton Catalog object | ||
| * @return a static reference to the Catalog object | ||
| */ | ||
| static CatalogInterface::CatalogType & getCatalog(); | ||
|
|
||
| /** | ||
| * @brief | ||
| * | ||
|
There was a problem hiding this comment. I would write the documentation at the abstraction level and use |
||
| */ | ||
| virtual void open() = 0; | ||
| }; | ||
|
|
||
| } | ||
|
|
||
| #endif /* GEOS_MESH_ExternalDataRepositoryBase_HPP */ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| /* | ||
| * ------------------------------------------------------------------------------------------------------------ | ||
| * SPDX-License-Identifier: LGPL-2.1-only | ||
| * | ||
| * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC | ||
| * Copyright (c) 2018-2024 Total, S.A | ||
| * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University | ||
| * Copyright (c) 2023-2024 Chevron | ||
| * Copyright (c) 2019- GEOS/GEOSX Contributors | ||
| * All rights reserved | ||
| * | ||
| * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details. | ||
| * ------------------------------------------------------------------------------------------------------------ | ||
| */ | ||
|
|
||
|
|
||
| #include "ExternalDataRepositoryManager.hpp" | ||
| #include "ExternalDataRepositoryBase.hpp" | ||
|
|
||
|
|
||
| namespace geos | ||
| { | ||
|
|
||
| using namespace dataRepository; | ||
|
|
||
| ExternalDataRepositoryManager::ExternalDataRepositoryManager( string const & name, | ||
| Group * const parent ): | ||
| Group( name, parent ) | ||
| { | ||
| setInputFlags( InputFlags::REQUIRED ); | ||
| } | ||
|
|
||
| ExternalDataRepositoryManager::~ExternalDataRepositoryManager() | ||
| {} | ||
|
|
||
| Group * ExternalDataRepositoryManager::createChild( string const & childKey, string const & childName ) | ||
| { | ||
| GEOS_LOG_RANK_0( "Adding External Data Repository: " << childKey << ", " << childName ); | ||
| std::unique_ptr< ExternalDataRepositoryBase > externalDataRepo = ExternalDataRepositoryBase::CatalogInterface::factory( childKey, childName, this ); | ||
| return &this->registerGroup< ExternalDataRepositoryBase >( childName, std::move( externalDataRepo ) ); | ||
| } | ||
|
|
||
|
|
||
| void ExternalDataRepositoryManager::expandObjectCatalogs() | ||
| { | ||
| // During schema generation, register one of each type derived from ExternalDataRepositoryBase here | ||
| for( auto & catalogIter: ExternalDataRepositoryBase::getCatalog()) | ||
| { | ||
| createChild( catalogIter.first, catalogIter.first ); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| void ExternalDataRepositoryManager::open( DomainPartition & GEOS_UNUSED_PARAM( domain ) ) | ||
| { | ||
| forSubGroups< ExternalDataRepositoryBase >( []( ExternalDataRepositoryBase & external ) | ||
| { | ||
| external.open(); | ||
| } ); | ||
| } | ||
|
|
||
|
|
||
| } /* namespace geos */ | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rrsettgast is this ok?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is fine...but why is this needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reverted