Flow123d  master-aa98e5e
Public Member Functions | Public Attributes | List of all members
TransportEqFields Class Reference

#include <transport_operator_splitting.hh>

Inheritance diagram for TransportEqFields:
Inheritance graph
[legend]
Collaboration diagram for TransportEqFields:
Collaboration graph
[legend]

Public Member Functions

 TransportEqFields ()
 
virtual ~TransportEqFields ()
 
- Public Member Functions inherited from FieldSet
 TYPEDEF_ERR_INFO (EI_FieldType, std::string)
 
 DECLARE_INPUT_EXCEPTION (ExcUnknownField,<< "Unknown field "<< FieldCommon::EI_Field::qval<< " in the "<< EI_FieldType::val<< ": \n")
 
 DECLARE_INPUT_EXCEPTION (ExcFieldExists,<< "Field "<< FieldCommon::EI_Field::qval<< " exists in equation. You cannot set user field of same name.\n")
 
 FieldSet ()
 Default constructor. 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)
 
FieldCommonfield (const std::string &field_name) const
 
FieldCommonoperator[] (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 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< FieldListAccessorfields_range () const
 Returns range of Fields held in field_list. More...
 
const Meshmesh () const
 Returns pointer to mesh. More...
 
std::string print_dependency () const
 Return order of evaluated fields by dependency and region_idx. More...
 
void set_default_fieldset ()
 

Public Attributes

Field< 3, FieldValue< 3 >::Scalar > porosity
 Mobile porosity - usually saturated water content in the case of unsaturated flow model. More...
 
Field< 3, FieldValue< 3 >::Scalar > water_content
 Water content - result of unsaturated water flow model or porosity. More...
 
Field< 3, FieldValue< 3 >::Scalar > cross_section
 Pointer to DarcyFlow field cross_section. More...
 
Field< 3, FieldValue< 3 >::VectorFixed > flow_flux
 Flow flux, can be result of water flow model. More...
 
MultiField< 3, FieldValue< 3 >::Scalar > sources_density
 Concentration sources - density of substance source, only positive part is used. More...
 
MultiField< 3, FieldValue< 3 >::Scalar > sources_sigma
 Concentration sources - Robin type, in_flux = sources_sigma * (sources_conc - mobile_conc) More...
 
MultiField< 3, FieldValue< 3 >::Scalar > sources_conc
 

Additional Inherited Members

- Public Types inherited from FieldSet
enum  UserFieldShape { scalar , vector , tensor }
 
- Public Types inherited from FieldFlag
typedef FlagArray< FieldFlagFlags
 
typedef Flags::Mask Mask
 
- Static Public Member Functions inherited from FieldSet
static const Input::Type::Selectionget_user_field_shape_selection ()
 Input selection of user field shape. More...
 
static const Input::Type::Recordmake_user_field_type (const std::string &equation_name)
 Declare input record type of field defined by user. 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...
 
const Meshmesh_
 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...
 
FieldMeshStep mesh_step_
 Field holds mesh step of element for computing of FieldFormulas. More...
 

Detailed Description

Class with fields that are common to all transport models.

Definition at line 137 of file transport_operator_splitting.hh.

Constructor & Destructor Documentation

◆ TransportEqFields()

TransportEqFields::TransportEqFields ( )

Definition at line 106 of file transport_operator_splitting.cc.

◆ ~TransportEqFields()

virtual TransportEqFields::~TransportEqFields ( )
inlinevirtual

Definition at line 141 of file transport_operator_splitting.hh.

Member Data Documentation

◆ cross_section

Field<3, FieldValue<3>::Scalar > TransportEqFields::cross_section

Pointer to DarcyFlow field cross_section.

Definition at line 150 of file transport_operator_splitting.hh.

◆ flow_flux

Field<3, FieldValue<3>::VectorFixed > TransportEqFields::flow_flux

Flow flux, can be result of water flow model.

Definition at line 153 of file transport_operator_splitting.hh.

◆ porosity

Field<3, FieldValue<3>::Scalar> TransportEqFields::porosity

Mobile porosity - usually saturated water content in the case of unsaturated flow model.

Definition at line 144 of file transport_operator_splitting.hh.

◆ sources_conc

MultiField<3, FieldValue<3>::Scalar> TransportEqFields::sources_conc

Definition at line 159 of file transport_operator_splitting.hh.

◆ sources_density

MultiField<3, FieldValue<3>::Scalar> TransportEqFields::sources_density

Concentration sources - density of substance source, only positive part is used.

Definition at line 156 of file transport_operator_splitting.hh.

◆ sources_sigma

MultiField<3, FieldValue<3>::Scalar> TransportEqFields::sources_sigma

Concentration sources - Robin type, in_flux = sources_sigma * (sources_conc - mobile_conc)

Definition at line 158 of file transport_operator_splitting.hh.

◆ water_content

Field<3, FieldValue<3>::Scalar> TransportEqFields::water_content

Water content - result of unsaturated water flow model or porosity.

Definition at line 147 of file transport_operator_splitting.hh.


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