#include <darcy_flow_mh.hh>
Public Types | |
| enum | BC_Type { none =0, dirichlet =1, total_flux =4, seepage =5, river =6 } |
 Public Types inherited from FieldFlag | |
| typedef FlagArray< FieldFlag > | Flags |
| typedef Flags::Mask | Mask |
Public Member Functions | |
| EqFields () | |
| Creation of all fields. More... | |
| FieldCoords & | X () |
| Return coords field. More... | |
| Public Member Functions inherited from FieldSet | |
| DECLARE_EXCEPTION (ExcUnknownField,<< "Field set has no field with name: "<< FieldCommon::EI_Field::qval) | |
| DECLARE_INPUT_EXCEPTION (ExcFieldNotSet,<< "Field "<< FieldCommon::EI_Field::qval<< " is not set. Please set key 'scalar_field', 'vector_field' or 'tensor_field' at: \n") | |
| FieldSet () | |
| Default constructor. More... | |
| const Input::Type::Record & | get_user_field (const std::string &equation_name) |
| Declare input record type of field defined by user. More... | |
| Input::Type::Record | make_field_descriptor_type (const std::string &equation_name) const |
| void | set_field (const std::string &dest_field_name, FieldCommon &source) |
| FieldCommon * | field (const std::string &field_name) const |
| FieldCommon & | operator[] (const std::string &field_name) const |
| void | set_components (const std::vector< string > &names) |
| void | set_mesh (const Mesh &mesh) |
| void | set_input_list (Input::Array input_list, const TimeGovernor &tg) |
| void | set_user_fields_map (Input::Array input_list) |
| void | flags_add (FieldFlag::Flags::Mask mask) |
| bool | set_time (const TimeStep &time, LimitSide limit_side) |
| void | output_type (OutputTime::DiscreteSpace rt) |
| void | mark_input_times (const TimeGovernor &tg) |
| bool | changed () const |
| bool | is_constant (Region reg) const |
| bool | is_jump_time () const |
| void | cache_reallocate (const ElementCacheMap &cache_map, FieldSet &used_fieldset) |
| void | cache_update (ElementCacheMap &cache_map) |
| void | set_dependency (FieldSet &used_fieldset) |
| void | add_coords_field () |
| void | set_surface_depth (std::shared_ptr< SurfaceDepth > surface_depth) |
| Set surface depth object to "d" field. More... | |
| Range< FieldListAccessor > | fields_range () const |
| Returns range of Fields held in field_list. More... | |
| const Mesh * | mesh () const |
| Returns pointer to mesh. More... | |
| std::string | print_dependency () const |
| Return order of evaluated fields by dependency and region_idx. More... | |
| FieldCommon * | user_field (const std::string &field_name, const TimeStep &time) |
Static Public Member Functions | |
| static const Input::Type::Selection & | get_bc_type_selection () |
| Return a Selection corresponding to enum BC_Type. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from FieldFlag | |
| static constexpr unsigned int | flags_size_ = 3 |
| Number of bits used by Field itself. More... | |
| static constexpr Mask | equation_input {1 << 0} |
| The field is data parameter of the owning equation. (default on) More... | |
| static constexpr Mask | declare_input {1 << 1} |
| The field can be set from input. The key in input field descriptor is declared. (default on) More... | |
| static constexpr Mask | allow_output {1 << 2} |
| The field can output. Is part of generated output selection. (default on) More... | |
| static constexpr Mask | input_copy = ~declare_input & equation_input |
| static constexpr Mask | in_time_term {1 << 8} |
| A field is part of time term of the equation. More... | |
| static constexpr Mask | in_main_matrix {1 << 9} |
| A field is part of main "stiffness matrix" of the equation. More... | |
| static constexpr Mask | in_rhs {1 << 10} |
| A field is part of the right hand side of the equation. More... | |
| static constexpr Mask | equation_result = allow_output & ~declare_input & ~equation_input |
| Match result fields. These are never given by input or copy of input. More... | |
| static constexpr Mask | equation_external_output = allow_output & input_copy |
| Match an output field, that can be also copy of other field. More... | |
| Protected Member Functions inherited from FieldSet | |
| void | topological_sort (const FieldCommon *f, unsigned int i_reg, std::unordered_set< const FieldCommon * > &used_fields) |
| Helper method sort used fields by dependency. More... | |
| Protected Attributes inherited from FieldSet | |
| std::vector< FieldCommon * > | field_list |
| List of all fields. More... | |
| std::vector< FieldCommon * > | user_field_list_ |
| List of fields defined by user. More... | |
| const Mesh * | mesh_ |
| Pointer to the mesh. More... | |
| std::map< unsigned int, std::vector< const FieldCommon * > > | region_field_update_order_ |
| FieldCoords | X_ |
| Field holds coordinates for computing of FieldFormulas. More... | |
| FieldDepth | depth_ |
| Field holds surface depth for computing of FieldFormulas. More... | |
| std::unordered_map< std::string, Input::Record > | user_fields_input_ |
| Map assigns Input::Record to each field defined in optional Input::Array 'user_fields'. More... | |
Detailed Description
Class with all fields used in the equation DarcyFlow. This is common to all implementations since this provides interface to this equation for possible coupling.
This class is the base class for equation data also in DarcyLMH and RichardsLMH classes especially due to the common output class DarcyFlowMHOutput. This is the only dependence between DarcyMH and DarcyLMH classes.
Definition at line 143 of file darcy_flow_mh.hh.
Member Enumeration Documentation
◆ BC_Type
For compatibility with old BCD file we have to assign integer codes starting from 1.
| Enumerator | |
|---|---|
| none | |
| dirichlet | |
| total_flux | |
| seepage | |
| river | |
Definition at line 149 of file darcy_flow_mh.hh.
Constructor & Destructor Documentation
◆ EqFields()
| DarcyMH::EqFields::EqFields | ( | ) |
Creation of all fields.
Definition at line 189 of file darcy_flow_mh.cc.
Member Function Documentation
◆ get_bc_type_selection()
|
static |
Return a Selection corresponding to enum BC_Type.
Definition at line 90 of file darcy_flow_mh.cc.
◆ X()
|
inline |
Return coords field.
Definition at line 164 of file darcy_flow_mh.hh.
Member Data Documentation
◆ anisotropy
| Field<3, FieldValue<3>::TensorFixed > DarcyMH::EqFields::anisotropy |
Definition at line 169 of file darcy_flow_mh.hh.
◆ bc_flux
| BCField<3, FieldValue<3>::Scalar > DarcyMH::EqFields::bc_flux |
Definition at line 177 of file darcy_flow_mh.hh.
◆ bc_gravity
| BCField<3, FieldValue<3>::VectorFixed > DarcyMH::EqFields::bc_gravity |
Holds gravity vector acceptable in FieldModel.
Definition at line 193 of file darcy_flow_mh.hh.
◆ bc_piezo_head
| BCField<3, FieldValue<3>::Scalar> DarcyMH::EqFields::bc_piezo_head |
Definition at line 195 of file darcy_flow_mh.hh.
◆ bc_pressure
| BCField<3, FieldValue<3>::Scalar > DarcyMH::EqFields::bc_pressure |
Definition at line 176 of file darcy_flow_mh.hh.
◆ bc_robin_sigma
| BCField<3, FieldValue<3>::Scalar > DarcyMH::EqFields::bc_robin_sigma |
Definition at line 178 of file darcy_flow_mh.hh.
◆ bc_switch_piezo_head
| BCField<3, FieldValue<3>::Scalar> DarcyMH::EqFields::bc_switch_piezo_head |
Definition at line 196 of file darcy_flow_mh.hh.
◆ bc_switch_pressure
| BCField<3, FieldValue<3>::Scalar > DarcyMH::EqFields::bc_switch_pressure |
Definition at line 179 of file darcy_flow_mh.hh.
◆ bc_type
| BCField<3, FieldValue<3>::Enum > DarcyMH::EqFields::bc_type |
Definition at line 175 of file darcy_flow_mh.hh.
◆ conductivity
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::conductivity |
Definition at line 170 of file darcy_flow_mh.hh.
◆ cross_section
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::cross_section |
Definition at line 171 of file darcy_flow_mh.hh.
◆ extra_source
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::extra_source |
Externally added storativity.
Definition at line 184 of file darcy_flow_mh.hh.
◆ extra_storativity
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::extra_storativity |
Definition at line 183 of file darcy_flow_mh.hh.
◆ field_edge_pressure
| Field<3, FieldValue<3>::Scalar> DarcyMH::EqFields::field_edge_pressure |
Definition at line 190 of file darcy_flow_mh.hh.
◆ field_ele_piezo_head
| Field<3, FieldValue<3>::Scalar> DarcyMH::EqFields::field_ele_piezo_head |
Definition at line 187 of file darcy_flow_mh.hh.
◆ field_ele_pressure
| Field<3, FieldValue<3>::Scalar> DarcyMH::EqFields::field_ele_pressure |
Externally added water source.
Definition at line 186 of file darcy_flow_mh.hh.
◆ field_ele_velocity
| Field<3, FieldValue<3>::VectorFixed > DarcyMH::EqFields::field_ele_velocity |
Definition at line 188 of file darcy_flow_mh.hh.
◆ flux
| Field<3, FieldValue<3>::VectorFixed > DarcyMH::EqFields::flux |
Definition at line 189 of file darcy_flow_mh.hh.
◆ gravity_field
| Field<3, FieldValue<3>::VectorFixed > DarcyMH::EqFields::gravity_field |
Definition at line 192 of file darcy_flow_mh.hh.
◆ init_piezo_head
| Field<3, FieldValue<3>::Scalar> DarcyMH::EqFields::init_piezo_head |
Same as previous but used in boundary fields.
Definition at line 194 of file darcy_flow_mh.hh.
◆ init_pressure
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::init_pressure |
Definition at line 181 of file darcy_flow_mh.hh.
◆ sigma
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::sigma |
Definition at line 173 of file darcy_flow_mh.hh.
◆ storativity
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::storativity |
Definition at line 182 of file darcy_flow_mh.hh.
◆ water_source_density
| Field<3, FieldValue<3>::Scalar > DarcyMH::EqFields::water_source_density |
Definition at line 172 of file darcy_flow_mh.hh.
The documentation for this class was generated from the following files:
- /opt/flow123d/flow123d/src/flow/darcy_flow_mh.hh
- /opt/flow123d/flow123d/src/flow/darcy_flow_mh.cc
