fieldDescription.hpp

#ifndef ABLATELIBRARY_FIELDDESCRIPTION_HPP
#define ABLATELIBRARY_FIELDDESCRIPTION_HPP
 
#include <petsc.h>
#include <algorithm>
#include <memory>
#include <parameters/parameters.hpp>
#include <string>
#include <utility>
#include <vector>
#include "domain/field.hpp"
#include "domain/region.hpp"
#include "fieldDescriptor.hpp"
 
namespace ablate::domain {
 
struct FieldDescription : public FieldDescriptor, public std::enable_shared_from_this<FieldDescription> {
    ~FieldDescription() override;
 
    // Helper variable, replaces any components with this value with one for each dimension
    inline const static std::string DIMENSION = "_DIMENSION_";
    inline const static std::vector<std::string> ONECOMPONENT = {"_"};
 
    // The name of the field
    const std::string name;
 
    // The prefix for field options
    const std::string prefix;
 
    // The components held in this field
    std::vector<std::string> components = {"_"};
 
    // If the field is solution or aux
    const enum FieldLocation location = FieldLocation::SOL;
 
    // The type of field (FEM/FVM)
    const enum FieldType type = FieldType::FEM;
 
    // The region for the field (nullptr is everywhere)
    const std::shared_ptr<domain::Region> region;
 
    // store any optional tags, there are strings that can be used to describe the field
    const std::vector<std::string> tags;
 
    FieldDescription(std::string name, const std::string& prefix, const std::vector<std::string>& components, FieldLocation location, FieldType type, std::shared_ptr<domain::Region> = {},
                     const std::shared_ptr<parameters::Parameters>& = {}, std::vector<std::string> tags = {});
 
    void DecompressComponents(PetscInt dim);
 
    std::vector<std::shared_ptr<FieldDescription>> GetFields() override;
 
    virtual PetscObject CreatePetscField(DM dm) const;
 
    inline std::shared_ptr<FieldDescription> Specialize(FieldType typeIn, std::shared_ptr<domain::Region> regionIn, std::shared_ptr<parameters::Parameters> optionsIn = {},
                                                        std::vector<std::string> tagsIn = {}) {
        return std::make_shared<FieldDescription>(name, prefix, components, location, typeIn, regionIn, optionsIn, tagsIn);
    }
 
   private:
    // keep the original Parameters
    std::shared_ptr<parameters::Parameters> options;
 
    // Petsc options specific for this field
    mutable PetscOptions petscOptions = nullptr;
};
 
}  // namespace ablate::domain
#endif  // ABLATELIBRARY_FIELDDESCRIPTION_HPP