#include <richards_lmh.hh>
Inheritance diagram for RichardsLMH::EqFields:
Collaboration diagram for RichardsLMH::EqFields:
Public Member Functions | |
| EqFields () | |
 Public Member Functions inherited from DarcyLMH::EqFields | |
| EqFields () | |
| Public Member Functions inherited from DarcyMH::EqFields | |
| 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) |
Additional Inherited Members | |
| Public Types inherited from DarcyMH::EqFields | |
| 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 |
| Static Public Member Functions inherited from DarcyMH::EqFields | |
| static const Input::Type::Selection & | get_bc_type_selection () |
| Return a Selection corresponding to enum BC_Type. More... | |
| 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.
Definition at line 68 of file richards_lmh.hh.
Constructor & Destructor Documentation
◆ EqFields()
| RichardsLMH::EqFields::EqFields | ( | ) |
Definition at line 41 of file richards_lmh.cc.
Member Data Documentation
◆ conductivity_ptr
| std::shared_ptr<FieldFE<3, FieldValue<3>::Scalar> > RichardsLMH::EqFields::conductivity_ptr |
Definition at line 83 of file richards_lmh.hh.
◆ conductivity_richards
| Field<3, FieldValue<3>::Scalar > RichardsLMH::EqFields::conductivity_richards |
Definition at line 81 of file richards_lmh.hh.
◆ genuchten_n_exponent
| Field<3, FieldValue<3>::Scalar > RichardsLMH::EqFields::genuchten_n_exponent |
Definition at line 75 of file richards_lmh.hh.
◆ genuchten_p_head_scale
| Field<3, FieldValue<3>::Scalar > RichardsLMH::EqFields::genuchten_p_head_scale |
Definition at line 74 of file richards_lmh.hh.
◆ water_content
| Field<3, FieldValue<3>::Scalar > RichardsLMH::EqFields::water_content |
Definition at line 78 of file richards_lmh.hh.
◆ water_content_ptr
| std::shared_ptr<FieldFE<3, FieldValue<3>::Scalar> > RichardsLMH::EqFields::water_content_ptr |
Definition at line 79 of file richards_lmh.hh.
◆ water_content_residual
| Field<3, FieldValue<3>::Scalar > RichardsLMH::EqFields::water_content_residual |
Definition at line 73 of file richards_lmh.hh.
◆ water_content_saturated
| Field<3, FieldValue<3>::Scalar > RichardsLMH::EqFields::water_content_saturated |
Definition at line 72 of file richards_lmh.hh.
The documentation for this class was generated from the following files:
- /opt/flow123d/flow123d/src/flow/richards_lmh.hh
- /opt/flow123d/flow123d/src/flow/richards_lmh.cc
